Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(4948)

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

Issue 8558015: Added chrome.experimental.devtools.panels.createStatusBarButton() (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 9 years, 1 month 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
Download patch
Index: chrome/common/extensions/docs/experimental.devtools.panels.html
diff --git a/chrome/common/extensions/docs/experimental.devtools.panels.html b/chrome/common/extensions/docs/experimental.devtools.panels.html
index 0aa26d6c2cb4bb2394465bbbb0ded702c70cb3d6..0ee3e8d22ee37849820456e76ca10ba3f60d1c90 100644
--- a/chrome/common/extensions/docs/experimental.devtools.panels.html
+++ b/chrome/common/extensions/docs/experimental.devtools.panels.html
@@ -370,11 +370,11 @@
</li><li>
<a href="#type-ExtensionPanel">ExtensionPanel</a>
<ol>
- <li style="display: none; ">
- <a>Methods</a>
+ <li>
+ <a href="#global-ExtensionPanel-methods">Methods</a>
<ol>
<li>
- <a href="#method-anchor">methodName</a>
+ <a href="#method-ExtensionPanel-createStatusBarButton">createStatusBarButton</a>
</li>
</ol>
</li>
@@ -419,6 +419,26 @@
</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>
@@ -1700,82 +1720,34 @@ You can find examples that use this API in
</dd>
<!-- OBJECT METHODS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
-
- <!-- OBJECT EVENT FIELDS -->
<dd>
- <div class="apiGroup" style="">
- <a name="global-ExtensionPanel-events"></a>
- <h3>Events of ExtensionPanel</h3>
- <!-- iterates over all events -->
+ <div class="apiGroup">
+ <a name="global-ExtensionPanel-methods"></a>
+ <h3>Methods of ExtensionPanel</h3>
+
+ <!-- iterates over all functions -->
<div class="apiItem">
- <a name="event-ExtensionPanel-onHidden"></a>
- <h4>onHidden</h4>
+ <a name="method-ExtensionPanel-createStatusBarButton"></a> <!-- method-anchor -->
+ <h4>createStatusBarButton</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <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="summary"><span style="">Button</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <span>extensionPanel.createStatusBarButton</span>(<span class="null"><span style="display: none; ">, </span><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 class="todo" style="display: none; ">Undocumented.</p>
- <p>Fired when the user switches away from the panel.</p>
-
- <!-- LISTENER PARAMETERS -->
- <div style="display: none; ">
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </div>
-
- <!-- EXTRA PARAMETERS -->
- <div style="display: none; ">
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </div>
+ <p>Appends a button to the status bar of the panel.</p>
- <!-- LISTENER RETURN VALUE -->
- <h4 style="display: none; ">Listener returns</h4>
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
<dl>
- <div style="display: none; ">
- <div>
- </div>
- </div>
- </dl>
-
- </div> <!-- /description -->
- </div><div class="apiItem">
- <a name="event-ExtensionPanel-onSearch"></a>
- <h4>onSearch</h4>
-
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <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 class="todo" style="display: none; ">Undocumented.</p>
- <p>Fired upon a search action (start of a new search, search result navigation, or search being canceled).</p>
-
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
+ <div>
<div>
- <div>
<dt>
- <var>action</var>
+ <var>iconPath</var>
<em>
<!-- TYPE -->
@@ -1803,7 +1775,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>Type of search action being performed.</dd>
+ <dd>Path to the icon of the button. The file should contain a 64x24 pixels image composed of two 32x24 icons. The left icon is used for inactive state of the button and the right one is displayed while the button is depressed.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -1840,16 +1812,16 @@ You can find examples that use this API in
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
- <var>queryString</var>
+ <var>tooltipText</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional">optional</span>
+ <span class="optional" style="display: none; ">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
@@ -1871,7 +1843,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>Query string (only for 'performSearch').</dd>
+ <dd>Text shown as a tooltip when user hovers the mouse over the button.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -1908,52 +1880,10 @@ You can find examples that use this API in
</dd>
</div>
- </div>
- </dl>
- </div>
-
- <!-- EXTRA PARAMETERS -->
- <div style="display: none; ">
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </div>
-
- <!-- LISTENER RETURN VALUE -->
- <h4 style="display: none; ">Listener returns</h4>
- <dl>
- <div style="display: none; ">
- <div>
- </div>
- </div>
- </dl>
-
- </div> <!-- /description -->
- </div><div class="apiItem">
- <a name="event-ExtensionPanel-onShown"></a>
- <h4>onShown</h4>
-
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">extensionPanel.</span><span>onShown</span><span class="subdued">.addListener</span>(function(<span>DOMWindow window</span>) <span class="subdued">{...}</span><span></span>);
- </div>
-
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Fired when the user switches to the panel.</p>
-
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
+ </div><div>
<div>
- <div>
<dt>
- <var>window</var>
+ <var>disabled</var>
<em>
<!-- TYPE -->
@@ -1969,7 +1899,7 @@ You can find examples that use this API in
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>DOMWindow</span>
+ <span>boolean</span>
<span style="display: none; "></span>
</span>
</span>
@@ -1981,7 +1911,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The <code>window</code> object of panel's page.</dd>
+ <dd>Whether the button is disabled.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2018,48 +1948,14 @@ You can find examples that use this API in
</dd>
</div>
- </div>
- </dl>
- </div>
-
- <!-- EXTRA PARAMETERS -->
- <div style="display: none; ">
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </div>
-
- <!-- LISTENER RETURN VALUE -->
- <h4 style="display: none; ">Listener returns</h4>
- <dl>
- <div style="display: none; ">
- <div>
- </div>
</div>
</dl>
- </div> <!-- /description -->
- </div> <!-- /apiItem -->
-
- </div>
- </dd>
-
- <!-- FUNCTION PARAMETERS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
-
- </div>
-
- </div><div class="apiItem">
- <a name="type-ExtensionSidebarPane"></a>
- <h4>ExtensionSidebarPane</h4>
-
- <div>
+ <!-- RETURNS -->
+ <h4 style="">Returns</h4>
+ <dl>
+ <div style="">
+ <div>
<dt>
<var style="display: none; ">paramName</var>
<em>
@@ -2070,15 +1966,15 @@ You can find examples that use this API in
<span class="optional" style="display: none; ">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
- <span style="display: none; ">
- <a> Type</a>
- </span>
<span>
- <span style="display: none; ">
+ <a href="experimental.devtools.panels.html#type-Button">Button</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>object</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -2086,10 +1982,12 @@ You can find examples that use this API in
</em>
</dt>
- <dd class="todo" style="display: none; ">
+ <dd class="todo">
Undocumented.
</dd>
- <dd>A sidebar created by the extension.</dd>
+ <dd style="display: none; ">
+ Description of this parameter from the json schema.
+ </dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2111,39 +2009,1162 @@ You can find examples that use this API in
</dd>
<!-- OBJECT METHODS -->
- <dd>
- <div class="apiGroup">
- <a name="global-ExtensionSidebarPane-methods"></a>
- <h3>Methods of ExtensionSidebarPane</h3>
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <!-- iterates over all functions -->
- <div class="apiItem">
- <a name="method-ExtensionSidebarPane-setExpression"></a> <!-- method-anchor -->
- <h4>setExpression</h4>
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>extensionSidebarPane.setExpression</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
- <var><span>expression</span></var></span><span class="optional"><span>, </span><span>string</span>
- <var><span>rootTitle</span></var></span>)</div>
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Sets an expression that is evaluated within the inspected page. The result is displayed in the sidebar pane.</p>
+ </div>
+ </div>
+ </dl>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
+ <!-- CALLBACK -->
+ <div style="display: none; ">
<div>
- <div>
- <dt>
- <var>expression</var>
- <em>
+ <h4>Callback function</h4>
+ <p style="display: none; ">
+ The callback <em>parameter</em> should specify a function
+ that looks like this:
+ </p>
+ <p>
+ If you specify the <em>callback</em> parameter, it should
+ specify a function that looks like this:
+ </p>
+
+ <!-- Note: intentionally longer 80 columns -->
+ <pre>function(<span>ExtensionPanel panel</span>) <span class="subdued">{...}</span>;</pre>
+ <dl>
+ <div>
+ <div>
+ <dt>
+ <var>panel</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span>
+ <a href="experimental.devtools.panels.html#type-ExtensionPanel">ExtensionPanel</a>
+ </span>
+ <span style="display: none; ">
+ <span>
+ array of <span><span></span></span>
+ </span>
+ <span>paramType</span>
+ <span></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>An ExtensionPanel object representing the created panel.</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div>
+ </dl>
+ </div>
+ </div>
+
+ <!-- MIN_VERSION -->
+ <p style="display: none; ">
+ This function was added in version <b><span></span></b>.
+ If you require this function, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </p>
+ </div> <!-- /description -->
+
+ </div> <!-- /apiItem -->
+
+ </div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd>
+ <div class="apiGroup" style="">
+ <a name="global-ExtensionPanel-events"></a>
+ <h3>Events of ExtensionPanel</h3>
+ <!-- iterates over all events -->
+ <div class="apiItem">
+ <a name="event-ExtensionPanel-onHidden"></a>
+ <h4>onHidden</h4>
+
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <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 class="todo" style="display: none; ">Undocumented.</p>
+ <p>Fired when the user switches away from the panel.</p>
+
+ <!-- LISTENER PARAMETERS -->
+ <div style="display: none; ">
+ <h4>Listener parameters</h4>
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- EXTRA PARAMETERS -->
+ <div style="display: none; ">
+ <h4>Extra parameters to addListener</h4>
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- LISTENER RETURN VALUE -->
+ <h4 style="display: none; ">Listener returns</h4>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+
+ </div> <!-- /description -->
+ </div><div class="apiItem">
+ <a name="event-ExtensionPanel-onSearch"></a>
+ <h4>onSearch</h4>
+
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <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 class="todo" style="display: none; ">Undocumented.</p>
+ <p>Fired upon a search action (start of a new search, search result navigation, or search being canceled).</p>
+
+ <!-- LISTENER PARAMETERS -->
+ <div>
+ <h4>Listener parameters</h4>
+ <dl>
+ <div>
+ <div>
+ <dt>
+ <var>action</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>string</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>Type of search action being performed.</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div><div>
+ <div>
+ <dt>
+ <var>queryString</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>string</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>Query string (only for 'performSearch').</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- EXTRA PARAMETERS -->
+ <div style="display: none; ">
+ <h4>Extra parameters to addListener</h4>
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- LISTENER RETURN VALUE -->
+ <h4 style="display: none; ">Listener returns</h4>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+
+ </div> <!-- /description -->
+ </div><div class="apiItem">
+ <a name="event-ExtensionPanel-onShown"></a>
+ <h4>onShown</h4>
+
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <span class="subdued">extensionPanel.</span><span>onShown</span><span class="subdued">.addListener</span>(function(<span>DOMWindow window</span>) <span class="subdued">{...}</span><span></span>);
+ </div>
+
+ <div class="description">
+ <p class="todo" style="display: none; ">Undocumented.</p>
+ <p>Fired when the user switches to the panel.</p>
+
+ <!-- LISTENER PARAMETERS -->
+ <div>
+ <h4>Listener parameters</h4>
+ <dl>
+ <div>
+ <div>
+ <dt>
+ <var>window</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>DOMWindow</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>The <code>window</code> object of panel's page.</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- EXTRA PARAMETERS -->
+ <div style="display: none; ">
+ <h4>Extra parameters to addListener</h4>
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- LISTENER RETURN VALUE -->
+ <h4 style="display: none; ">Listener returns</h4>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+
+ </div> <!-- /description -->
+ </div> <!-- /apiItem -->
+
+ </div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+
+ </div><div class="apiItem">
+ <a name="type-ExtensionSidebarPane"></a>
+ <h4>ExtensionSidebarPane</h4>
+
+ <div>
+ <dt>
+ <var style="display: none; ">paramName</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>object</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>A sidebar created by the extension.</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd>
+ <div class="apiGroup">
+ <a name="global-ExtensionSidebarPane-methods"></a>
+ <h3>Methods of ExtensionSidebarPane</h3>
+
+ <!-- iterates over all functions -->
+ <div class="apiItem">
+ <a name="method-ExtensionSidebarPane-setExpression"></a> <!-- method-anchor -->
+ <h4>setExpression</h4>
+
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <span>extensionSidebarPane.setExpression</span>(<span class="null"><span style="display: none; ">, </span><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 class="todo" style="display: none; ">Undocumented.</p>
+ <p>Sets an expression that is evaluated within the inspected page. The result is displayed in the sidebar pane.</p>
+
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
+ <div>
+ <dt>
+ <var>expression</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>string</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <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>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div><div>
+ <div>
+ <dt>
+ <var>rootTitle</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>string</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>An optional title for the root of the expression tree.</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div><div>
+ <div>
+ <dt>
+ <var>callback</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>function</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>A callback invoked after the sidebar pane is updated with the the expression evaluation results.</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div>
+ </dl>
+
+ <!-- RETURNS -->
+ <h4 style="display: none; ">Returns</h4>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+
+ <!-- CALLBACK -->
+ <div>
+ <div>
+ <h4>Callback function</h4>
+ <p style="display: none; ">
+ The callback <em>parameter</em> should specify a function
+ that looks like this:
+ </p>
+ <p>
+ If you specify the <em>callback</em> parameter, it should
+ specify a function that looks like this:
+ </p>
+
+ <!-- Note: intentionally longer 80 columns -->
+ <pre>function(<span>null</span>) <span class="subdued">{...}</span>;</pre>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ <dt>
+ <var>panel</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span>
+ <a href="experimental.devtools.panels.html#type-ExtensionPanel">ExtensionPanel</a>
+ </span>
+ <span style="display: none; ">
+ <span>
+ array of <span><span></span></span>
+ </span>
+ <span>paramType</span>
+ <span></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>An ExtensionPanel object representing the created panel.</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div>
+ </dl>
+ </div>
+ </div>
+
+ <!-- MIN_VERSION -->
+ <p style="display: none; ">
+ This function was added in version <b><span></span></b>.
+ If you require this function, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </p>
+ </div> <!-- /description -->
+
+ </div><div class="apiItem">
+ <a name="method-ExtensionSidebarPane-setHeight"></a> <!-- method-anchor -->
+ <h4>setHeight</h4>
+
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <span>extensionSidebarPane.setHeight</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
+ <var><span>height</span></var></span>)</div>
+
+ <div class="description">
+ <p class="todo" style="display: none; ">Undocumented.</p>
+ <p>Sets the height of the sidebar.</p>
+
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
+ <div>
+ <dt>
+ <var>height</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>string</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>A CSS-like size specification, such as <code>'100px'</code> or <code>'12ex'</code>.</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div>
+ </dl>
+
+ <!-- RETURNS -->
+ <h4 style="display: none; ">Returns</h4>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+
+ <!-- CALLBACK -->
+ <div style="display: none; ">
+ <div>
+ <h4>Callback function</h4>
+ <p style="display: none; ">
+ The callback <em>parameter</em> should specify a function
+ that looks like this:
+ </p>
+ <p>
+ If you specify the <em>callback</em> parameter, it should
+ specify a function that looks like this:
+ </p>
+
+ <!-- Note: intentionally longer 80 columns -->
+ <pre>function(<span>object Resource</span>) <span class="subdued">{...}</span>;</pre>
+ <dl>
+ <div>
+ <div>
+ <dt>
+ <var>Resource</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>object</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>A <a href="experimental.devtools.inspectedWindow.html#type-Resource">Resource</a> object for the resource that was clicked.</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div>
+ </dl>
+ </div>
+ </div>
+
+ <!-- MIN_VERSION -->
+ <p style="display: none; ">
+ This function was added in version <b><span></span></b>.
+ If you require this function, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </p>
+ </div> <!-- /description -->
+
+ </div><div class="apiItem">
+ <a name="method-ExtensionSidebarPane-setObject"></a> <!-- method-anchor -->
+ <h4>setObject</h4>
+
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <span>extensionSidebarPane.setObject</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
+ <var><span>jsonObject</span></var></span><span class="optional"><span style="">, </span><span>string</span>
+ <var><span>rootTitle</span></var></span><span class="optional"><span style="">, </span><span>function</span>
+ <var><span>callback</span></var></span>)</div>
+
+ <div class="description">
+ <p class="todo" style="display: none; ">Undocumented.</p>
+ <p>Sets a JSON-compliant object to be displayed in the sidebar pane.</p>
+
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
+ <div>
+ <dt>
+ <var>jsonObject</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>string</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>An object to be displayed in context of the inspected page. Evaluated in the context of the caller (API client).</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div><div>
+ <div>
+ <dt>
+ <var>rootTitle</var>
+ <em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional" style="display: none; ">optional</span>
+ <span class="optional">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
@@ -2165,7 +3186,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <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>
+ <dd>An optional title for the root of the expression tree.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2205,13 +3226,13 @@ You can find examples that use this API in
</div><div>
<div>
<dt>
- <var>rootTitle</var>
+ <var>callback</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional" style="">optional</span>
+ <span class="optional">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
@@ -2221,7 +3242,7 @@ You can find examples that use this API in
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>string</span>
+ <span>function</span>
<span style="display: none; "></span>
</span>
</span>
@@ -2233,7 +3254,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>An optional title for the root of the expression tree.</dd>
+ <dd>A callback invoked after the sidebar is updated with the object.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2283,7 +3304,7 @@ You can find examples that use this API in
</dl>
<!-- CALLBACK -->
- <div style="display: none; ">
+ <div>
<div>
<h4>Callback function</h4>
<p style="display: none; ">
@@ -2296,12 +3317,12 @@ You can find examples that use this API in
</p>
<!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>ExtensionPanel panel</span>) <span class="subdued">{...}</span>;</pre>
+ <pre>function(<span>null</span>) <span class="subdued">{...}</span>;</pre>
<dl>
- <div>
+ <div style="display: none; ">
<div>
<dt>
- <var>panel</var>
+ <var>Resource</var>
<em>
<!-- TYPE -->
@@ -2310,15 +3331,15 @@ You can find examples that use this API in
<span class="optional" style="display: none; ">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
- <span>
- <a href="experimental.devtools.panels.html#type-ExtensionPanel">ExtensionPanel</a>
- </span>
<span style="display: none; ">
- <span>
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>paramType</span>
- <span></span>
+ <span>object</span>
+ <span style="display: none; "></span>
</span>
</span>
)
@@ -2329,7 +3350,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>An ExtensionPanel object representing the created panel.</dd>
+ <dd>A <a href="experimental.devtools.inspectedWindow.html#type-Resource">Resource</a> object for the resource that was clicked.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2381,17 +3402,17 @@ You can find examples that use this API in
</div> <!-- /description -->
</div><div class="apiItem">
- <a name="method-ExtensionSidebarPane-setHeight"></a> <!-- method-anchor -->
- <h4>setHeight</h4>
+ <a name="method-ExtensionSidebarPane-setPage"></a> <!-- method-anchor -->
+ <h4>setPage</h4>
<div class="summary"><span style="display: none; ">void</span>
<!-- Note: intentionally longer 80 columns -->
- <span>extensionSidebarPane.setHeight</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
- <var><span>height</span></var></span>)</div>
+ <span>extensionSidebarPane.setPage</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
+ <var><span>path</span></var></span>)</div>
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
- <p>Sets the height of the sidebar.</p>
+ <p>Sets an HTML page to be displayed in the sidebar pane.</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
@@ -2399,7 +3420,7 @@ You can find examples that use this API in
<div>
<div>
<dt>
- <var>height</var>
+ <var>path</var>
<em>
<!-- TYPE -->
@@ -2427,7 +3448,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>A CSS-like size specification, e.g. '10px' or '12pt'.</dd>
+ <dd>Relative path of an extension page to display within the sidebar.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2574,27 +3595,191 @@ You can find examples that use this API in
</p>
</div> <!-- /description -->
+ </div> <!-- /apiItem -->
+
+ </div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd>
+ <div class="apiGroup" style="">
+ <a name="global-ExtensionSidebarPane-events"></a>
+ <h3>Events of ExtensionSidebarPane</h3>
+ <!-- iterates over all events -->
+ <div class="apiItem">
+ <a name="event-ExtensionSidebarPane-onHidden"></a>
+ <h4>onHidden</h4>
+
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <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 class="todo" style="display: none; ">Undocumented.</p>
+ <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>
+
+ <!-- LISTENER PARAMETERS -->
+ <div style="display: none; ">
+ <h4>Listener parameters</h4>
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- EXTRA PARAMETERS -->
+ <div style="display: none; ">
+ <h4>Extra parameters to addListener</h4>
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- LISTENER RETURN VALUE -->
+ <h4 style="display: none; ">Listener returns</h4>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+
+ </div> <!-- /description -->
</div><div class="apiItem">
- <a name="method-ExtensionSidebarPane-setObject"></a> <!-- method-anchor -->
- <h4>setObject</h4>
+ <a name="event-ExtensionSidebarPane-onShown"></a>
+ <h4>onShown</h4>
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>extensionSidebarPane.setObject</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
- <var><span>jsonObject</span></var></span><span class="optional"><span style="">, </span><span>string</span>
- <var><span>rootTitle</span></var></span>)</div>
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <span class="subdued">extensionSidebarPane.</span><span>onShown</span><span class="subdued">.addListener</span>(function(<span>DOMWindow window</span>) <span class="subdued">{...}</span><span></span>);
+ </div>
+
+ <div class="description">
+ <p class="todo" style="display: none; ">Undocumented.</p>
+ <p>Fired when the sidebar pane becomes visible as a result of user switching to the panel that hosts it.</p>
+
+ <!-- LISTENER PARAMETERS -->
+ <div>
+ <h4>Listener parameters</h4>
+ <dl>
+ <div>
+ <div>
+ <dt>
+ <var>window</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional">optional</span>
+ <span class="enum" style="display: none; ">enumerated</span>
+ <span id="typeTemplate">
+ <span style="display: none; ">
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
+ array of <span><span></span></span>
+ </span>
+ <span>DOMWindow</span>
+ <span style="display: none; "></span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>The <code>window</code> object of the sidebar page, if one was set with the <code>setPage()</code> method.</dd>
+ <dd style="display: none; ">
+ This parameter was added in version
+ <b><span></span></b>.
+ You must omit this parameter in earlier versions,
+ and you may omit it in any version. If you require this
+ parameter, the manifest key
+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+ can ensure that your extension won't be run in an earlier browser version.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- EXTRA PARAMETERS -->
+ <div style="display: none; ">
+ <h4>Extra parameters to addListener</h4>
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- LISTENER RETURN VALUE -->
+ <h4 style="display: none; ">Listener returns</h4>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+
+ </div> <!-- /description -->
+ </div> <!-- /apiItem -->
+
+ </div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Sets a JSON-compliant object to be displayed in the sidebar pane.</p>
+ </div>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
+ </div><div class="apiItem">
+ <a name="type-Button"></a>
+ <h4>Button</h4>
+
+ <div>
<dt>
- <var>jsonObject</var>
+ <var style="display: none; ">paramName</var>
<em>
<!-- TYPE -->
@@ -2610,7 +3795,7 @@ You can find examples that use this API in
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>string</span>
+ <span>object</span>
<span style="display: none; "></span>
</span>
</span>
@@ -2622,7 +3807,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>An object to be displayed in context of the inspected page. Evaluated in the context of the caller (API client).</dd>
+ <dd>A button created by the extension.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2644,31 +3829,40 @@ You can find examples that use this API in
</dd>
<!-- OBJECT METHODS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
+ <dd>
+ <div class="apiGroup">
+ <a name="global-Button-methods"></a>
+ <h3>Methods of Button</h3>
- <!-- OBJECT EVENT FIELDS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
+ <!-- iterates over all functions -->
+ <div class="apiItem">
+ <a name="method-Button-update"></a> <!-- method-anchor -->
+ <h4>update</h4>
- <!-- FUNCTION PARAMETERS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <span>button.update</span>(<span class="optional"><span style="display: none; ">, </span><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>
- </div><div>
+ <div class="description">
+ <p class="todo" style="display: none; ">Undocumented.</p>
+ <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>
+
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
<div>
<dt>
- <var>rootTitle</var>
+ <var>iconPath</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional">optional</span>
+ <span class="optional" style="">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
@@ -2690,7 +3884,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>An optional title for the root of the expression tree.</dd>
+ <dd>Path to the new icon of the button.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2727,44 +3921,16 @@ You can find examples that use this API in
</dd>
</div>
- </div>
- </dl>
-
- <!-- RETURNS -->
- <h4 style="display: none; ">Returns</h4>
- <dl>
- <div style="display: none; ">
- <div>
- </div>
- </div>
- </dl>
-
- <!-- CALLBACK -->
- <div style="display: none; ">
- <div>
- <h4>Callback function</h4>
- <p style="display: none; ">
- The callback <em>parameter</em> should specify a function
- that looks like this:
- </p>
- <p>
- If you specify the <em>callback</em> parameter, it should
- specify a function that looks like this:
- </p>
-
- <!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>object Resource</span>) <span class="subdued">{...}</span>;</pre>
- <dl>
+ </div><div>
<div>
- <div>
<dt>
- <var>Resource</var>
+ <var>tooltipText</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional" style="display: none; ">optional</span>
+ <span class="optional" style="">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
@@ -2774,7 +3940,7 @@ You can find examples that use this API in
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>object</span>
+ <span>string</span>
<span style="display: none; "></span>
</span>
</span>
@@ -2786,7 +3952,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>A <a href="experimental.devtools.inspectedWindow.html#type-Resource">Resource</a> object for the resource that was clicked.</dd>
+ <dd>Text shown as a tooltip when user hovers the mouse over the button.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2823,46 +3989,16 @@ You can find examples that use this API in
</dd>
</div>
- </div>
- </dl>
- </div>
- </div>
-
- <!-- MIN_VERSION -->
- <p style="display: none; ">
- This function was added in version <b><span></span></b>.
- If you require this function, the manifest key
- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
- can ensure that your extension won't be run in an earlier browser version.
- </p>
- </div> <!-- /description -->
-
- </div><div class="apiItem">
- <a name="method-ExtensionSidebarPane-setPage"></a> <!-- method-anchor -->
- <h4>setPage</h4>
-
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>extensionSidebarPane.setPage</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
- <var><span>path</span></var></span>)</div>
-
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Sets an HTML page to be displayed in the sidebar pane.</p>
-
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
+ </div><div>
<div>
<dt>
- <var>path</var>
+ <var>disabled</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional" style="display: none; ">optional</span>
+ <span class="optional" style="">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
@@ -2872,7 +4008,7 @@ You can find examples that use this API in
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>string</span>
+ <span>boolean</span>
<span style="display: none; "></span>
</span>
</span>
@@ -2884,7 +4020,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>Relative path of an extension page to display within the sidebar.</dd>
+ <dd>Whether the button is disabled.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2947,12 +4083,12 @@ You can find examples that use this API in
</p>
<!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>object Resource</span>) <span class="subdued">{...}</span>;</pre>
+ <pre>function(<span>ExtensionPanel panel</span>) <span class="subdued">{...}</span>;</pre>
<dl>
<div>
<div>
<dt>
- <var>Resource</var>
+ <var>panel</var>
<em>
<!-- TYPE -->
@@ -2961,15 +4097,15 @@ You can find examples that use this API in
<span class="optional" style="display: none; ">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
- <span style="display: none; ">
- <a> Type</a>
- </span>
<span>
- <span style="display: none; ">
+ <a href="experimental.devtools.panels.html#type-ExtensionPanel">ExtensionPanel</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>object</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -2980,7 +4116,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>A <a href="experimental.devtools.inspectedWindow.html#type-Resource">Resource</a> object for the resource that was clicked.</dd>
+ <dd>An ExtensionPanel object representing the created panel.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -3039,21 +4175,21 @@ You can find examples that use this API in
<!-- OBJECT EVENT FIELDS -->
<dd>
<div class="apiGroup" style="">
- <a name="global-ExtensionSidebarPane-events"></a>
- <h3>Events of ExtensionSidebarPane</h3>
+ <a name="global-Button-events"></a>
+ <h3>Events of Button</h3>
<!-- iterates over all events -->
<div class="apiItem">
- <a name="event-ExtensionSidebarPane-onHidden"></a>
- <h4>onHidden</h4>
+ <a name="event-Button-onClicked"></a>
+ <h4>onClicked</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span class="subdued">extensionSidebarPane.</span><span>onHidden</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);
+ <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 class="todo" style="display: none; ">Undocumented.</p>
- <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>
+ <p>Fired when the button is clicked.</p>
<!-- LISTENER PARAMETERS -->
<div style="display: none; ">
@@ -3087,116 +4223,6 @@ You can find examples that use this API in
</dl>
</div> <!-- /description -->
- </div><div class="apiItem">
- <a name="event-ExtensionSidebarPane-onShown"></a>
- <h4>onShown</h4>
-
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">extensionSidebarPane.</span><span>onShown</span><span class="subdued">.addListener</span>(function(<span>DOMWindow window</span>) <span class="subdued">{...}</span><span></span>);
- </div>
-
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Fired when the sidebar pane becomes visible as a result of user switching to the panel that hosts it.</p>
-
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>window</var>
- <em>
-
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span class="enum" style="display: none; ">enumerated</span>
- <span id="typeTemplate">
- <span style="display: none; ">
- <a> Type</a>
- </span>
- <span>
- <span style="display: none; ">
- array of <span><span></span></span>
- </span>
- <span>DOMWindow</span>
- <span style="display: none; "></span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>The <code>window</code> object of the sidebar page, if one was set with the <code>setPage()</code> method.</dd>
- <dd style="display: none; ">
- This parameter was added in version
- <b><span></span></b>.
- You must omit this parameter in earlier versions,
- and you may omit it in any version. If you require this
- parameter, the manifest key
- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
- can ensure that your extension won't be run in an earlier browser version.
- </dd>
-
- <!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </dd>
-
- <!-- OBJECT METHODS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
-
- <!-- OBJECT EVENT FIELDS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
-
- <!-- FUNCTION PARAMETERS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
-
- </div>
- </div>
- </dl>
- </div>
-
- <!-- EXTRA PARAMETERS -->
- <div style="display: none; ">
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </div>
-
- <!-- LISTENER RETURN VALUE -->
- <h4 style="display: none; ">Listener returns</h4>
- <dl>
- <div style="display: none; ">
- <div>
- </div>
- </div>
- </dl>
-
- </div> <!-- /description -->
</div> <!-- /apiItem -->
</div>

Powered by Google App Engine
This is Rietveld 408576698