1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 2 1) The <head> information in this page is significant, should be uniform 3 across api docs and should be edited only with knowledge of the 4 templating mechanism. 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 6 browser, it will be re-generated from the template, json schema and 7 authored overview content. 8 4) The <body>.innerHTML is also generated by an offline step so that this 9 page may easily be indexed by search engines. 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js"> 15 </script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script> 18 <script type="text/javascript" src="js/sidebar.js"></script> 19 <title>chrome.experimental.sidebar - Google Chrome Extensions - Google Code</title></head> 20 <body> <div id="gc-container" class="labs"> 21 <div id="devModeWarning"> 22 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. 23 </div> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 25 <!-- In particular, sub-templates that recurse, must be used by allowing 26 jstemplate to make a copy of the template in this section which 27 are not operated on by way of the jsskip="true" --> 28 <div style="display:none"> 29 30 <!-- VALUE --> 31 <div id="valueTemplate"> 32 <dt> 33 <var>paramName</var> 34 <em> 35 36 <!-- TYPE --> 37 <div style="display:inline"> 38 ( 39 <span class="optional">optional</span> 40 <span class="enum">enumerated</span> 41 <span id="typeTemplate"> 42 <span> 43 <a> Type</a> 44 </span> 45 <span> 46 <span> 47 array of <span><span></span></span> 48 </span> 49 <span>paramType</span> 50 <span></span> 51 </span> 52 </span> 53 ) 54 </div> 55 56 </em> 57 </dt> 58 <dd class="todo"> 59 Undocumented. 60 </dd> 61 <dd> 62 Description of this parameter from the json schema. 63 </dd> 64 <dd> 65 This parameter was added in version 66 <b><span></span></b>. 67 You must omit this parameter in earlier versions, 68 and you may omit it in any version. If you require this 69 parameter, the manifest key 70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 71 can ensure that your extension won't be run in an earlier browser version. 72 </dd> 73 74 <!-- OBJECT PROPERTIES --> 75 <dd> 76 <dl> 77 <div> 78 <div> 79 </div> 80 </div> 81 </dl> 82 </dd> 83 84 <!-- OBJECT METHODS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 <!-- OBJECT EVENT FIELDS --> 90 <dd> 91 <div></div> 92 </dd> 93 94 <!-- FUNCTION PARAMETERS --> 95 <dd> 96 <div></div> 97 </dd> 98 99 </div> <!-- /VALUE --> 100 101 <div id="functionParametersTemplate"> 102 <h5>Parameters</h5> 103 <dl> 104 <div> 105 <div> 106 </div> 107 </div> 108 </dl> 109 </div> 110 </div> <!-- /SUBTEMPLATES --> 111 112 <a id="top"></a> 113 <div id="skipto"> 114 <a href="#gc-pagecontent">Skip to page content</a> 115 <a href="#gc-toc">Skip to main navigation</a> 116 </div> 117 <!-- API HEADER --> 118 <table id="header" width="100%" cellspacing="0" border="0"> 119 <tbody><tr> 120 <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> 121 <td valign="middle" width="100%" style="padding-left:0.6em;"> 122 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 123 <div id="gsc-search-box"> 124 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 125 <input type="hidden" name="ie" value="UTF-8"> 126 <input type="text" name="q" value="" size="55"> 127 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 128 <br> 129 <span class="greytext">e.g. "page action" or "tabs"</span> 130 </div> 131 </form> 132 133 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 134 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 136 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 137 </td> 138 </tr> 139 </tbody></table> 140 141 <div id="codesiteContent" class=""> 142 143 <a id="gc-topnav-anchor"></a> 144 <div id="gc-topnav"> 145 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 146 <ul id="home" class="gc-topnav-tabs"> 147 <li id="home_link"> 148 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 149 </li> 150 <li id="docs_link"> 151 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 152 </li> 153 <li id="faq_link"> 154 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 155 </li> 156 <li id="samples_link"> 157 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 158 </li> 159 <li id="group_link"> 160 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 161 </li> 162 </ul> 163 </div> <!-- end gc-topnav --> 164 165 <div class="g-section g-tpl-170"> 166 <!-- SIDENAV --> 167 <div class="g-unit g-first" id="gc-toc"> 168 <ul> 169 <li><a href="getstarted.html">Getting Started</a></li> 170 <li><a href="overview.html">Overview</a></li> 171 <li><a href="whats_new.html">What's New?</a></li> 172 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 173 <ul> 174 <li>Browser UI 175 <ul> 176 <li><a href="browserAction.html">Browser Actions</a></li> 177 <li><a href="contextMenus.html">Context Menus</a></li> 178 <li><a href="notifications.html">Desktop Notifications</a></li> 179 <li><a href="omnibox.html">Omnibox</a></li> 180 <li><a href="options.html">Options Pages</a></li> 181 <li><a href="override.html">Override Pages</a></li> 182 <li><a href="pageAction.html">Page Actions</a></li> 183 </ul> 184 </li> 185 <li>Browser Interaction 186 <ul> 187 <li><a href="bookmarks.html">Bookmarks</a></li> 188 <li><a href="cookies.html">Cookies</a></li> 189 <li><a href="events.html">Events</a></li> 190 <li><a href="history.html">History</a></li> 191 <li><a href="management.html">Management</a></li> 192 <li><a href="tabs.html">Tabs</a></li> 193 <li><a href="windows.html">Windows</a></li> 194 </ul> 195 </li> 196 <li>Implementation 197 <ul> 198 <li><a href="a11y.html">Accessibility</a></li> 199 <li><a href="background_pages.html">Background Pages</a></li> 200 <li><a href="content_scripts.html">Content Scripts</a></li> 201 <li><a href="xhr.html">Cross-Origin XHR</a></li> 202 <li><a href="idle.html">Idle</a></li> 203 <li><a href="i18n.html">Internationalization</a></li> 204 <li><a href="messaging.html">Message Passing</a></li> 205 <li><a href="npapi.html">NPAPI Plugins</a></li> 206 </ul> 207 </li> 208 <li>Finishing 209 <ul> 210 <li><a href="hosting.html">Hosting</a></li> 211 <li><a href="external_extensions.html">Other Deployment Options</a></li> 212 </ul> 213 </li> 214 </ul> 215 </li> 216 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 217 <li><h2><a href="tutorials.html">Tutorials</a></h2> 218 <ul> 219 <li><a href="tut_debugging.html">Debugging</a></li> 220 <li><a href="tut_analytics.html">Google Analytics</a></li> 221 <li><a href="tut_oauth.html">OAuth</a></li> 222 </ul> 223 </li> 224 <li><h2>Reference</h2> 225 <ul> 226 <li>Formats 227 <ul> 228 <li><a href="manifest.html">Manifest Files</a></li> 229 <li><a href="match_patterns.html">Match Patterns</a></li> 230 </ul> 231 </li> 232 <li><a href="permission_warnings.html">Permission Warnings</a></li> 233 <li><a href="api_index.html">chrome.* APIs</a></li> 234 <li><a href="api_other.html">Other APIs</a></li> 235 </ul> 236 </li> 237 <li><h2><a href="samples.html">Samples</a></h2></li> 238 <div class="line"> </div> 239 <li><h2>More</h2> 240 <ul> 241 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 242 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 243 <li><a href="themes.html">Themes</a></li> 244 </ul> 245 </li> 246 </ul> 247 </div> 248 <script> 249 initToggles(); 250 </script> 251 252 <div class="g-unit" id="gc-pagecontent"> 253 <div id="pageTitle"> 254 <h1 class="page_title">chrome.experimental.sidebar</h1> 255 </div> 256 <!-- TABLE OF CONTENTS --> 257 <div id="toc"> 258 <h2>Contents</h2> 259 <ol> 260 <li style="display: none; "> 261 <a>h2Name</a> 262 <ol> 263 <li> 264 <a>h3Name</a> 265 </li> 266 </ol> 267 </li> 268 <li> 269 <a href="#apiReference">API reference: chrome.experimental.sidebar</a> 270 <ol> 271 <li style="display: none; "> 272 <a href="#properties">Properties</a> 273 <ol> 274 <li> 275 <a href="#property-anchor">propertyName</a> 276 </li> 277 </ol> 278 </li> 279 <li> 280 <a href="#global-methods">Methods</a> 281 <ol> 282 <li> 283 <a href="#method-collapse">collapse</a> 284 </li><li> 285 <a href="#method-expand">expand</a> 286 </li><li> 287 <a href="#method-getState">getState</a> 288 </li><li> 289 <a href="#method-hide">hide</a> 290 </li><li> 291 <a href="#method-navigate">navigate</a> 292 </li><li> 293 <a href="#method-setBadgeText">setBadgeText</a> 294 </li><li> 295 <a href="#method-setIcon">setIcon</a> 296 </li><li> 297 <a href="#method-setTitle">setTitle</a> 298 </li><li> 299 <a href="#method-show">show</a> 300 </li> 301 </ol> 302 </li> 303 <li> 304 <a href="#global-events">Events</a> 305 <ol> 306 <li> 307 <a href="#event-onStateChanged">onStateChanged</a> 308 </li> 309 </ol> 310 </li> 311 <li style="display: none; "> 312 <a href="#types">Types</a> 313 <ol> 314 <li> 315 <a href="#id-anchor">id</a> 316 </li> 317 </ol> 318 </li> 319 </ol> 320 </li> 321 </ol> 322 </div> 323 <!-- /TABLE OF CONTENTS --> 324 325 <!-- Standard content lead-in for experimental API pages --> 326 <p id="classSummary"> 327 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 328 </p> 329 330 <!-- STATIC CONTENT PLACEHOLDER --> 331 <div id="static"></div> 332 333 <!-- API PAGE --> 334 <div class="apiPage"> 335 <a name="apiReference"></a> 336 <h2>API reference: chrome.experimental.sidebar</h2> 337 338 <!-- PROPERTIES --> 339 <div class="apiGroup" style="display: none; "> 340 <a name="properties"></a> 341 <h3 id="properties">Properties</h3> 342 343 <div> 344 <a></a> 345 <h4>getLastError</h4> 346 <div class="summary"> 347 <!-- Note: intentionally longer 80 columns --> 348 <span>chrome.extension</span><span>lastError</span> 349 </div> 350 <div> 351 </div> 352 </div> 353 354 </div> <!-- /apiGroup --> 355 356 <!-- METHODS --> 357 <div id="methodsTemplate" class="apiGroup"> 358 <a name="global-methods"></a> 359 <h3>Methods</h3> 360 361 <!-- iterates over all functions --> 362 <div class="apiItem"> 363 <a name="method-collapse"></a> <!-- method-anchor --> 364 <h4>collapse</h4> 365 366 <div class="summary"><span style="display: none; ">void</span> 367 <!-- Note: intentionally longer 80 columns --> 368 <span>chrome.experimental.sidebar.collapse</span>(<span class="optional"><span style="display: none; ">, </span><span>object</span> 369 <var><span>details</span></var></span>)</div> 370 371 <div class="description"> 372 <p class="todo" style="display: none; ">Undocumented.</p> 373 <p>Collapses sidebar for the specified tab. Has no effect if sidebar is not in its 'active' state (see getState).</p> 374 375 <!-- PARAMETERS --> 376 <h4>Parameters</h4> 377 <dl> 378 <div> 379 <div> 380 <dt> 381 <var>details</var> 382 <em> 383 384 <!-- TYPE --> 385 <div style="display:inline"> 386 ( 387 <span class="optional">optional</span> 388 <span class="enum" style="display: none; ">enumerated</span> 389 <span id="typeTemplate"> 390 <span style="display: none; "> 391 <a> Type</a> 392 </span> 393 <span> 394 <span style="display: none; "> 395 array of <span><span></span></span> 396 </span> 397 <span>object</span> 398 <span style="display: none; "></span> 399 </span> 400 </span> 401 ) 402 </div> 403 404 </em> 405 </dt> 406 <dd class="todo"> 407 Undocumented. 408 </dd> 409 <dd style="display: none; "> 410 Description of this parameter from the json schema. 411 </dd> 412 <dd style="display: none; "> 413 This parameter was added in version 414 <b><span></span></b>. 415 You must omit this parameter in earlier versions, 416 and you may omit it in any version. If you require this 417 parameter, the manifest key 418 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 419 can ensure that your extension won't be run in an earlier browser version. 420 </dd> 421 422 <!-- OBJECT PROPERTIES --> 423 <dd> 424 <dl> 425 <div> 426 <div> 427 <dt> 428 <var>tabId</var> 429 <em> 430 431 <!-- TYPE --> 432 <div style="display:inline"> 433 ( 434 <span class="optional">optional</span> 435 <span class="enum" style="display: none; ">enumerated</span> 436 <span id="typeTemplate"> 437 <span style="display: none; "> 438 <a> Type</a> 439 </span> 440 <span> 441 <span style="display: none; "> 442 array of <span><span></span></span> 443 </span> 444 <span>integer</span> 445 <span style="display: none; "></span> 446 </span> 447 </span> 448 ) 449 </div> 450 451 </em> 452 </dt> 453 <dd class="todo" style="display: none; "> 454 Undocumented. 455 </dd> 456 <dd>Defaults to the selected tab of the <a href="windows.html#current-window">current window</a>.</dd> 457 <dd style="display: none; "> 458 This parameter was added in version 459 <b><span></span></b>. 460 You must omit this parameter in earlier versions, 461 and you may omit it in any version. If you require this 462 parameter, the manifest key 463 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 464 can ensure that your extension won't be run in an earlier browser version. 465 </dd> 466 467 <!-- OBJECT PROPERTIES --> 468 <dd style="display: none; "> 469 <dl> 470 <div> 471 <div> 472 </div> 473 </div> 474 </dl> 475 </dd> 476 477 <!-- OBJECT METHODS --> 478 <dd style="display: none; "> 479 <div></div> 480 </dd> 481 482 <!-- OBJECT EVENT FIELDS --> 483 <dd style="display: none; "> 484 <div></div> 485 </dd> 486 487 <!-- FUNCTION PARAMETERS --> 488 <dd style="display: none; "> 489 <div></div> 490 </dd> 491 492 </div> 493 </div> 494 </dl> 495 </dd> 496 497 <!-- OBJECT METHODS --> 498 <dd style="display: none; "> 499 <div></div> 500 </dd> 501 502 <!-- OBJECT EVENT FIELDS --> 503 <dd style="display: none; "> 504 <div></div> 505 </dd> 506 507 <!-- FUNCTION PARAMETERS --> 508 <dd style="display: none; "> 509 <div></div> 510 </dd> 511 512 </div> 513 </div> 514 </dl> 515 516 <!-- RETURNS --> 517 <h4 style="display: none; ">Returns</h4> 518 <dl> 519 <div style="display: none; "> 520 <div> 521 </div> 522 </div> 523 </dl> 524 525 <!-- CALLBACK --> 526 <div style="display: none; "> 527 <div> 528 <h4>Callback function</h4> 529 <p> 530 The callback <em>parameter</em> should specify a function 531 that looks like this: 532 </p> 533 <p> 534 If you specify the <em>callback</em> parameter, it should 535 specify a function that looks like this: 536 </p> 537 538 <!-- Note: intentionally longer 80 columns --> 539 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 540 <dl> 541 <div> 542 <div> 543 </div> 544 </div> 545 </dl> 546 </div> 547 </div> 548 549 <!-- MIN_VERSION --> 550 <p style="display: none; "> 551 This function was added in version <b><span></span></b>. 552 If you require this function, the manifest key 553 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 554 can ensure that your extension won't be run in an earlier browser version. 555 </p> 556 </div> <!-- /description --> 557 558 </div><div class="apiItem"> 559 <a name="method-expand"></a> <!-- method-anchor --> 560 <h4>expand</h4> 561 562 <div class="summary"><span style="display: none; ">void</span> 563 <!-- Note: intentionally longer 80 columns --> 564 <span>chrome.experimental.sidebar.expand</span>(<span class="optional"><span style="display: none; ">, </span><span>object</span> 565 <var><span>details</span></var></span>)</div> 566 567 <div class="description"> 568 <p class="todo" style="display: none; ">Undocumented.</p> 569 <p>Expands sidebar and switches to the specified content (if it was displaying another extension's sidebar content) for the specified tab. Extension is allowed to expand sidebar only in response to an explicit user gesture.</p> 570 571 <!-- PARAMETERS --> 572 <h4>Parameters</h4> 573 <dl> 574 <div> 575 <div> 576 <dt> 577 <var>details</var> 578 <em> 579 580 <!-- TYPE --> 581 <div style="display:inline"> 582 ( 583 <span class="optional">optional</span> 584 <span class="enum" style="display: none; ">enumerated</span> 585 <span id="typeTemplate"> 586 <span style="display: none; "> 587 <a> Type</a> 588 </span> 589 <span> 590 <span style="display: none; "> 591 array of <span><span></span></span> 592 </span> 593 <span>object</span> 594 <span style="display: none; "></span> 595 </span> 596 </span> 597 ) 598 </div> 599 600 </em> 601 </dt> 602 <dd class="todo"> 603 Undocumented. 604 </dd> 605 <dd style="display: none; "> 606 Description of this parameter from the json schema. 607 </dd> 608 <dd style="display: none; "> 609 This parameter was added in version 610 <b><span></span></b>. 611 You must omit this parameter in earlier versions, 612 and you may omit it in any version. If you require this 613 parameter, the manifest key 614 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 615 can ensure that your extension won't be run in an earlier browser version. 616 </dd> 617 618 <!-- OBJECT PROPERTIES --> 619 <dd> 620 <dl> 621 <div> 622 <div> 623 <dt> 624 <var>tabId</var> 625 <em> 626 627 <!-- TYPE --> 628 <div style="display:inline"> 629 ( 630 <span class="optional">optional</span> 631 <span class="enum" style="display: none; ">enumerated</span> 632 <span id="typeTemplate"> 633 <span style="display: none; "> 634 <a> Type</a> 635 </span> 636 <span> 637 <span style="display: none; "> 638 array of <span><span></span></span> 639 </span> 640 <span>integer</span> 641 <span style="display: none; "></span> 642 </span> 643 </span> 644 ) 645 </div> 646 647 </em> 648 </dt> 649 <dd class="todo" style="display: none; "> 650 Undocumented. 651 </dd> 652 <dd>Defaults to the selected tab of the <a href="windows.html#current-window">current window</a>.</dd> 653 <dd style="display: none; "> 654 This parameter was added in version 655 <b><span></span></b>. 656 You must omit this parameter in earlier versions, 657 and you may omit it in any version. If you require this 658 parameter, the manifest key 659 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 660 can ensure that your extension won't be run in an earlier browser version. 661 </dd> 662 663 <!-- OBJECT PROPERTIES --> 664 <dd style="display: none; "> 665 <dl> 666 <div> 667 <div> 668 </div> 669 </div> 670 </dl> 671 </dd> 672 673 <!-- OBJECT METHODS --> 674 <dd style="display: none; "> 675 <div></div> 676 </dd> 677 678 <!-- OBJECT EVENT FIELDS --> 679 <dd style="display: none; "> 680 <div></div> 681 </dd> 682 683 <!-- FUNCTION PARAMETERS --> 684 <dd style="display: none; "> 685 <div></div> 686 </dd> 687 688 </div> 689 </div> 690 </dl> 691 </dd> 692 693 <!-- OBJECT METHODS --> 694 <dd style="display: none; "> 695 <div></div> 696 </dd> 697 698 <!-- OBJECT EVENT FIELDS --> 699 <dd style="display: none; "> 700 <div></div> 701 </dd> 702 703 <!-- FUNCTION PARAMETERS --> 704 <dd style="display: none; "> 705 <div></div> 706 </dd> 707 708 </div> 709 </div> 710 </dl> 711 712 <!-- RETURNS --> 713 <h4 style="display: none; ">Returns</h4> 714 <dl> 715 <div style="display: none; "> 716 <div> 717 </div> 718 </div> 719 </dl> 720 721 <!-- CALLBACK --> 722 <div style="display: none; "> 723 <div> 724 <h4>Callback function</h4> 725 <p> 726 The callback <em>parameter</em> should specify a function 727 that looks like this: 728 </p> 729 <p> 730 If you specify the <em>callback</em> parameter, it should 731 specify a function that looks like this: 732 </p> 733 734 <!-- Note: intentionally longer 80 columns --> 735 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 736 <dl> 737 <div> 738 <div> 739 </div> 740 </div> 741 </dl> 742 </div> 743 </div> 744 745 <!-- MIN_VERSION --> 746 <p style="display: none; "> 747 This function was added in version <b><span></span></b>. 748 If you require this function, the manifest key 749 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 750 can ensure that your extension won't be run in an earlier browser version. 751 </p> 752 </div> <!-- /description --> 753 754 </div><div class="apiItem"> 755 <a name="method-getState"></a> <!-- method-anchor --> 756 <h4>getState</h4> 757 758 <div class="summary"><span style="display: none; ">void</span> 759 <!-- Note: intentionally longer 80 columns --> 760 <span>chrome.experimental.sidebar.getState</span>(<span class="optional"><span style="display: none; ">, </span><span>object</span> 761 <var><span>details</span></var></span><span class="null"><span>, </span><span>function</span> 762 <var><span>callback</span></var></span>)</div> 763 764 <div class="description"> 765 <p class="todo" style="display: none; ">Undocumented.</p> 766 <p>Returns current sidebar state for the specified tab.</p> 767 768 <!-- PARAMETERS --> 769 <h4>Parameters</h4> 770 <dl> 771 <div> 772 <div> 773 <dt> 774 <var>details</var> 775 <em> 776 777 <!-- TYPE --> 778 <div style="display:inline"> 779 ( 780 <span class="optional">optional</span> 781 <span class="enum" style="display: none; ">enumerated</span> 782 <span id="typeTemplate"> 783 <span style="display: none; "> 784 <a> Type</a> 785 </span> 786 <span> 787 <span style="display: none; "> 788 array of <span><span></span></span> 789 </span> 790 <span>object</span> 791 <span style="display: none; "></span> 792 </span> 793 </span> 794 ) 795 </div> 796 797 </em> 798 </dt> 799 <dd class="todo"> 800 Undocumented. 801 </dd> 802 <dd style="display: none; "> 803 Description of this parameter from the json schema. 804 </dd> 805 <dd style="display: none; "> 806 This parameter was added in version 807 <b><span></span></b>. 808 You must omit this parameter in earlier versions, 809 and you may omit it in any version. If you require this 810 parameter, the manifest key 811 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 812 can ensure that your extension won't be run in an earlier browser version. 813 </dd> 814 815 <!-- OBJECT PROPERTIES --> 816 <dd> 817 <dl> 818 <div> 819 <div> 820 <dt> 821 <var>tabId</var> 822 <em> 823 824 <!-- TYPE --> 825 <div style="display:inline"> 826 ( 827 <span class="optional">optional</span> 828 <span class="enum" style="display: none; ">enumerated</span> 829 <span id="typeTemplate"> 830 <span style="display: none; "> 831 <a> Type</a> 832 </span> 833 <span> 834 <span style="display: none; "> 835 array of <span><span></span></span> 836 </span> 837 <span>integer</span> 838 <span style="display: none; "></span> 839 </span> 840 </span> 841 ) 842 </div> 843 844 </em> 845 </dt> 846 <dd class="todo" style="display: none; "> 847 Undocumented. 848 </dd> 849 <dd>Defaults to the selected tab of the <a href="windows.html#current-window">current window</a>.</dd> 850 <dd style="display: none; "> 851 This parameter was added in version 852 <b><span></span></b>. 853 You must omit this parameter in earlier versions, 854 and you may omit it in any version. If you require this 855 parameter, the manifest key 856 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 857 can ensure that your extension won't be run in an earlier browser version. 858 </dd> 859 860 <!-- OBJECT PROPERTIES --> 861 <dd style="display: none; "> 862 <dl> 863 <div> 864 <div> 865 </div> 866 </div> 867 </dl> 868 </dd> 869 870 <!-- OBJECT METHODS --> 871 <dd style="display: none; "> 872 <div></div> 873 </dd> 874 875 <!-- OBJECT EVENT FIELDS --> 876 <dd style="display: none; "> 877 <div></div> 878 </dd> 879 880 <!-- FUNCTION PARAMETERS --> 881 <dd style="display: none; "> 882 <div></div> 883 </dd> 884 885 </div> 886 </div> 887 </dl> 888 </dd> 889 890 <!-- OBJECT METHODS --> 891 <dd style="display: none; "> 892 <div></div> 893 </dd> 894 895 <!-- OBJECT EVENT FIELDS --> 896 <dd style="display: none; "> 897 <div></div> 898 </dd> 899 900 <!-- FUNCTION PARAMETERS --> 901 <dd style="display: none; "> 902 <div></div> 903 </dd> 904 905 </div> 906 </div><div> 907 <div> 908 <dt> 909 <var>callback</var> 910 <em> 911 912 <!-- TYPE --> 913 <div style="display:inline"> 914 ( 915 <span class="optional" style="display: none; ">optional</span> 916 <span class="enum" style="display: none; ">enumerated</span> 917 <span id="typeTemplate"> 918 <span style="display: none; "> 919 <a> Type</a> 920 </span> 921 <span> 922 <span style="display: none; "> 923 array of <span><span></span></span> 924 </span> 925 <span>function</span> 926 <span style="display: none; "></span> 927 </span> 928 </span> 929 ) 930 </div> 931 932 </em> 933 </dt> 934 <dd class="todo"> 935 Undocumented. 936 </dd> 937 <dd style="display: none; "> 938 Description of this parameter from the json schema. 939 </dd> 940 <dd style="display: none; "> 941 This parameter was added in version 942 <b><span></span></b>. 943 You must omit this parameter in earlier versions, 944 and you may omit it in any version. If you require this 945 parameter, the manifest key 946 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 947 can ensure that your extension won't be run in an earlier browser version. 948 </dd> 949 950 <!-- OBJECT PROPERTIES --> 951 <dd style="display: none; "> 952 <dl> 953 <div> 954 <div> 955 </div> 956 </div> 957 </dl> 958 </dd> 959 960 <!-- OBJECT METHODS --> 961 <dd style="display: none; "> 962 <div></div> 963 </dd> 964 965 <!-- OBJECT EVENT FIELDS --> 966 <dd style="display: none; "> 967 <div></div> 968 </dd> 969 970 <!-- FUNCTION PARAMETERS --> 971 <dd style="display: none; "> 972 <div></div> 973 </dd> 974 975 </div> 976 </div> 977 </dl> 978 979 <!-- RETURNS --> 980 <h4 style="display: none; ">Returns</h4> 981 <dl> 982 <div style="display: none; "> 983 <div> 984 </div> 985 </div> 986 </dl> 987 988 <!-- CALLBACK --> 989 <div> 990 <div> 991 <h4>Callback function</h4> 992 <p> 993 The callback <em>parameter</em> should specify a function 994 that looks like this: 995 </p> 996 <p style="display: none; "> 997 If you specify the <em>callback</em> parameter, it should 998 specify a function that looks like this: 999 </p> 1000 1001 <!-- Note: intentionally longer 80 columns --> 1002 <pre>function(<span>string state</span>) <span class="subdued">{...}</span>;</pre> 1003 <dl> 1004 <div> 1005 <div> 1006 <dt> 1007 <var>state</var> 1008 <em> 1009 1010 <!-- TYPE --> 1011 <div style="display:inline"> 1012 ( 1013 <span class="optional" style="display: none; ">optional</span> 1014 <span class="enum">enumerated</span> 1015 <span id="typeTemplate"> 1016 <span style="display: none; "> 1017 <a> Type</a> 1018 </span> 1019 <span> 1020 <span style="display: none; "> 1021 array of <span><span></span></span> 1022 </span> 1023 <span>string</span> 1024 <span>["hidden", "shown", "active"]</span> 1025 </span> 1026 </span> 1027 ) 1028 </div> 1029 1030 </em> 1031 </dt> 1032 <dd class="todo" style="display: none; "> 1033 Undocumented. 1034 </dd> 1035 <dd>'hidden' indicates sidebar is not defined for the specified tab (show was never called or hide() was called). Nothing is displayed for this sidebar.<br>'shown' means sidebar is defined for the specified tab; mini tab is displayed for this sidebar. Sidebar UI is either collapsed or displaying a content of some other extension's sidebar.<br>'active' indicates that sidebar is defined for the specified tab; sidebar UI is expanded and displaying this sidebar's content.</dd> 1036 <dd style="display: none; "> 1037 This parameter was added in version 1038 <b><span></span></b>. 1039 You must omit this parameter in earlier versions, 1040 and you may omit it in any version. If you require this 1041 parameter, the manifest key 1042 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1043 can ensure that your extension won't be run in an earlier browser version. 1044 </dd> 1045 1046 <!-- OBJECT PROPERTIES --> 1047 <dd style="display: none; "> 1048 <dl> 1049 <div> 1050 <div> 1051 </div> 1052 </div> 1053 </dl> 1054 </dd> 1055 1056 <!-- OBJECT METHODS --> 1057 <dd style="display: none; "> 1058 <div></div> 1059 </dd> 1060 1061 <!-- OBJECT EVENT FIELDS --> 1062 <dd style="display: none; "> 1063 <div></div> 1064 </dd> 1065 1066 <!-- FUNCTION PARAMETERS --> 1067 <dd style="display: none; "> 1068 <div></div> 1069 </dd> 1070 1071 </div> 1072 </div> 1073 </dl> 1074 </div> 1075 </div> 1076 1077 <!-- MIN_VERSION --> 1078 <p style="display: none; "> 1079 This function was added in version <b><span></span></b>. 1080 If you require this function, the manifest key 1081 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1082 can ensure that your extension won't be run in an earlier browser version. 1083 </p> 1084 </div> <!-- /description --> 1085 1086 </div><div class="apiItem"> 1087 <a name="method-hide"></a> <!-- method-anchor --> 1088 <h4>hide</h4> 1089 1090 <div class="summary"><span style="display: none; ">void</span> 1091 <!-- Note: intentionally longer 80 columns --> 1092 <span>chrome.experimental.sidebar.hide</span>(<span class="optional"><span style="display: none; ">, </span><span>object</span> 1093 <var><span>details</span></var></span>)</div> 1094 1095 <div class="description"> 1096 <p class="todo" style="display: none; ">Undocumented.</p> 1097 <p>Hides sidebar's mini tab for the specified tab and collapses sidebar if it was in 'active' state (see getState). Has no effect if the sidebar is already hidden.</p> 1098 1099 <!-- PARAMETERS --> 1100 <h4>Parameters</h4> 1101 <dl> 1102 <div> 1103 <div> 1104 <dt> 1105 <var>details</var> 1106 <em> 1107 1108 <!-- TYPE --> 1109 <div style="display:inline"> 1110 ( 1111 <span class="optional">optional</span> 1112 <span class="enum" style="display: none; ">enumerated</span> 1113 <span id="typeTemplate"> 1114 <span style="display: none; "> 1115 <a> Type</a> 1116 </span> 1117 <span> 1118 <span style="display: none; "> 1119 array of <span><span></span></span> 1120 </span> 1121 <span>object</span> 1122 <span style="display: none; "></span> 1123 </span> 1124 </span> 1125 ) 1126 </div> 1127 1128 </em> 1129 </dt> 1130 <dd class="todo"> 1131 Undocumented. 1132 </dd> 1133 <dd style="display: none; "> 1134 Description of this parameter from the json schema. 1135 </dd> 1136 <dd style="display: none; "> 1137 This parameter was added in version 1138 <b><span></span></b>. 1139 You must omit this parameter in earlier versions, 1140 and you may omit it in any version. If you require this 1141 parameter, the manifest key 1142 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1143 can ensure that your extension won't be run in an earlier browser version. 1144 </dd> 1145 1146 <!-- OBJECT PROPERTIES --> 1147 <dd> 1148 <dl> 1149 <div> 1150 <div> 1151 <dt> 1152 <var>tabId</var> 1153 <em> 1154 1155 <!-- TYPE --> 1156 <div style="display:inline"> 1157 ( 1158 <span class="optional">optional</span> 1159 <span class="enum" style="display: none; ">enumerated</span> 1160 <span id="typeTemplate"> 1161 <span style="display: none; "> 1162 <a> Type</a> 1163 </span> 1164 <span> 1165 <span style="display: none; "> 1166 array of <span><span></span></span> 1167 </span> 1168 <span>integer</span> 1169 <span style="display: none; "></span> 1170 </span> 1171 </span> 1172 ) 1173 </div> 1174 1175 </em> 1176 </dt> 1177 <dd class="todo" style="display: none; "> 1178 Undocumented. 1179 </dd> 1180 <dd>Defaults to the selected tab of the <a href="windows.html#current-window">current window</a>.</dd> 1181 <dd style="display: none; "> 1182 This parameter was added in version 1183 <b><span></span></b>. 1184 You must omit this parameter in earlier versions, 1185 and you may omit it in any version. If you require this 1186 parameter, the manifest key 1187 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1188 can ensure that your extension won't be run in an earlier browser version. 1189 </dd> 1190 1191 <!-- OBJECT PROPERTIES --> 1192 <dd style="display: none; "> 1193 <dl> 1194 <div> 1195 <div> 1196 </div> 1197 </div> 1198 </dl> 1199 </dd> 1200 1201 <!-- OBJECT METHODS --> 1202 <dd style="display: none; "> 1203 <div></div> 1204 </dd> 1205 1206 <!-- OBJECT EVENT FIELDS --> 1207 <dd style="display: none; "> 1208 <div></div> 1209 </dd> 1210 1211 <!-- FUNCTION PARAMETERS --> 1212 <dd style="display: none; "> 1213 <div></div> 1214 </dd> 1215 1216 </div> 1217 </div> 1218 </dl> 1219 </dd> 1220 1221 <!-- OBJECT METHODS --> 1222 <dd style="display: none; "> 1223 <div></div> 1224 </dd> 1225 1226 <!-- OBJECT EVENT FIELDS --> 1227 <dd style="display: none; "> 1228 <div></div> 1229 </dd> 1230 1231 <!-- FUNCTION PARAMETERS --> 1232 <dd style="display: none; "> 1233 <div></div> 1234 </dd> 1235 1236 </div> 1237 </div> 1238 </dl> 1239 1240 <!-- RETURNS --> 1241 <h4 style="display: none; ">Returns</h4> 1242 <dl> 1243 <div style="display: none; "> 1244 <div> 1245 </div> 1246 </div> 1247 </dl> 1248 1249 <!-- CALLBACK --> 1250 <div style="display: none; "> 1251 <div> 1252 <h4>Callback function</h4> 1253 <p> 1254 The callback <em>parameter</em> should specify a function 1255 that looks like this: 1256 </p> 1257 <p> 1258 If you specify the <em>callback</em> parameter, it should 1259 specify a function that looks like this: 1260 </p> 1261 1262 <!-- Note: intentionally longer 80 columns --> 1263 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1264 <dl> 1265 <div> 1266 <div> 1267 </div> 1268 </div> 1269 </dl> 1270 </div> 1271 </div> 1272 1273 <!-- MIN_VERSION --> 1274 <p style="display: none; "> 1275 This function was added in version <b><span></span></b>. 1276 If you require this function, the manifest key 1277 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1278 can ensure that your extension won't be run in an earlier browser version. 1279 </p> 1280 </div> <!-- /description --> 1281 1282 </div><div class="apiItem"> 1283 <a name="method-navigate"></a> <!-- method-anchor --> 1284 <h4>navigate</h4> 1285 1286 <div class="summary"><span style="display: none; ">void</span> 1287 <!-- Note: intentionally longer 80 columns --> 1288 <span>chrome.experimental.sidebar.navigate</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1289 <var><span>details</span></var></span>)</div> 1290 1291 <div class="description"> 1292 <p class="todo" style="display: none; ">Undocumented.</p> 1293 <p>Loads the the specified html file into the sidebar for the specified tab.</p> 1294 1295 <!-- PARAMETERS --> 1296 <h4>Parameters</h4> 1297 <dl> 1298 <div> 1299 <div> 1300 <dt> 1301 <var>details</var> 1302 <em> 1303 1304 <!-- TYPE --> 1305 <div style="display:inline"> 1306 ( 1307 <span class="optional" style="display: none; ">optional</span> 1308 <span class="enum" style="display: none; ">enumerated</span> 1309 <span id="typeTemplate"> 1310 <span style="display: none; "> 1311 <a> Type</a> 1312 </span> 1313 <span> 1314 <span style="display: none; "> 1315 array of <span><span></span></span> 1316 </span> 1317 <span>object</span> 1318 <span style="display: none; "></span> 1319 </span> 1320 </span> 1321 ) 1322 </div> 1323 1324 </em> 1325 </dt> 1326 <dd class="todo"> 1327 Undocumented. 1328 </dd> 1329 <dd style="display: none; "> 1330 Description of this parameter from the json schema. 1331 </dd> 1332 <dd style="display: none; "> 1333 This parameter was added in version 1334 <b><span></span></b>. 1335 You must omit this parameter in earlier versions, 1336 and you may omit it in any version. If you require this 1337 parameter, the manifest key 1338 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1339 can ensure that your extension won't be run in an earlier browser version. 1340 </dd> 1341 1342 <!-- OBJECT PROPERTIES --> 1343 <dd> 1344 <dl> 1345 <div> 1346 <div> 1347 <dt> 1348 <var>tabId</var> 1349 <em> 1350 1351 <!-- TYPE --> 1352 <div style="display:inline"> 1353 ( 1354 <span class="optional">optional</span> 1355 <span class="enum" style="display: none; ">enumerated</span> 1356 <span id="typeTemplate"> 1357 <span style="display: none; "> 1358 <a> Type</a> 1359 </span> 1360 <span> 1361 <span style="display: none; "> 1362 array of <span><span></span></span> 1363 </span> 1364 <span>integer</span> 1365 <span style="display: none; "></span> 1366 </span> 1367 </span> 1368 ) 1369 </div> 1370 1371 </em> 1372 </dt> 1373 <dd class="todo" style="display: none; "> 1374 Undocumented. 1375 </dd> 1376 <dd>Defaults to the selected tab of the <a href="windows.html#current-window">current window</a>.</dd> 1377 <dd style="display: none; "> 1378 This parameter was added in version 1379 <b><span></span></b>. 1380 You must omit this parameter in earlier versions, 1381 and you may omit it in any version. If you require this 1382 parameter, the manifest key 1383 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1384 can ensure that your extension won't be run in an earlier browser version. 1385 </dd> 1386 1387 <!-- OBJECT PROPERTIES --> 1388 <dd style="display: none; "> 1389 <dl> 1390 <div> 1391 <div> 1392 </div> 1393 </div> 1394 </dl> 1395 </dd> 1396 1397 <!-- OBJECT METHODS --> 1398 <dd style="display: none; "> 1399 <div></div> 1400 </dd> 1401 1402 <!-- OBJECT EVENT FIELDS --> 1403 <dd style="display: none; "> 1404 <div></div> 1405 </dd> 1406 1407 <!-- FUNCTION PARAMETERS --> 1408 <dd style="display: none; "> 1409 <div></div> 1410 </dd> 1411 1412 </div> 1413 </div><div> 1414 <div> 1415 <dt> 1416 <var>path</var> 1417 <em> 1418 1419 <!-- TYPE --> 1420 <div style="display:inline"> 1421 ( 1422 <span class="optional" style="display: none; ">optional</span> 1423 <span class="enum" style="display: none; ">enumerated</span> 1424 <span id="typeTemplate"> 1425 <span style="display: none; "> 1426 <a> Type</a> 1427 </span> 1428 <span> 1429 <span style="display: none; "> 1430 array of <span><span></span></span> 1431 </span> 1432 <span>string</span> 1433 <span style="display: none; "></span> 1434 </span> 1435 </span> 1436 ) 1437 </div> 1438 1439 </em> 1440 </dt> 1441 <dd class="todo" style="display: none; "> 1442 Undocumented. 1443 </dd> 1444 <dd>Relative path to the html file in the extension to show in the sidebar.</dd> 1445 <dd style="display: none; "> 1446 This parameter was added in version 1447 <b><span></span></b>. 1448 You must omit this parameter in earlier versions, 1449 and you may omit it in any version. If you require this 1450 parameter, the manifest key 1451 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1452 can ensure that your extension won't be run in an earlier browser version. 1453 </dd> 1454 1455 <!-- OBJECT PROPERTIES --> 1456 <dd style="display: none; "> 1457 <dl> 1458 <div> 1459 <div> 1460 </div> 1461 </div> 1462 </dl> 1463 </dd> 1464 1465 <!-- OBJECT METHODS --> 1466 <dd style="display: none; "> 1467 <div></div> 1468 </dd> 1469 1470 <!-- OBJECT EVENT FIELDS --> 1471 <dd style="display: none; "> 1472 <div></div> 1473 </dd> 1474 1475 <!-- FUNCTION PARAMETERS --> 1476 <dd style="display: none; "> 1477 <div></div> 1478 </dd> 1479 1480 </div> 1481 </div> 1482 </dl> 1483 </dd> 1484 1485 <!-- OBJECT METHODS --> 1486 <dd style="display: none; "> 1487 <div></div> 1488 </dd> 1489 1490 <!-- OBJECT EVENT FIELDS --> 1491 <dd style="display: none; "> 1492 <div></div> 1493 </dd> 1494 1495 <!-- FUNCTION PARAMETERS --> 1496 <dd style="display: none; "> 1497 <div></div> 1498 </dd> 1499 1500 </div> 1501 </div> 1502 </dl> 1503 1504 <!-- RETURNS --> 1505 <h4 style="display: none; ">Returns</h4> 1506 <dl> 1507 <div style="display: none; "> 1508 <div> 1509 </div> 1510 </div> 1511 </dl> 1512 1513 <!-- CALLBACK --> 1514 <div style="display: none; "> 1515 <div> 1516 <h4>Callback function</h4> 1517 <p> 1518 The callback <em>parameter</em> should specify a function 1519 that looks like this: 1520 </p> 1521 <p> 1522 If you specify the <em>callback</em> parameter, it should 1523 specify a function that looks like this: 1524 </p> 1525 1526 <!-- Note: intentionally longer 80 columns --> 1527 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1528 <dl> 1529 <div> 1530 <div> 1531 </div> 1532 </div> 1533 </dl> 1534 </div> 1535 </div> 1536 1537 <!-- MIN_VERSION --> 1538 <p style="display: none; "> 1539 This function was added in version <b><span></span></b>. 1540 If you require this function, the manifest key 1541 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1542 can ensure that your extension won't be run in an earlier browser version. 1543 </p> 1544 </div> <!-- /description --> 1545 1546 </div><div class="apiItem"> 1547 <a name="method-setBadgeText"></a> <!-- method-anchor --> 1548 <h4>setBadgeText</h4> 1549 1550 <div class="summary"><span style="display: none; ">void</span> 1551 <!-- Note: intentionally longer 80 columns --> 1552 <span>chrome.experimental.sidebar.setBadgeText</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1553 <var><span>details</span></var></span>)</div> 1554 1555 <div class="description"> 1556 <p class="todo" style="display: none; ">Undocumented.</p> 1557 <p>Sets sidebar's mini tab badge text for the specified tab.</p> 1558 1559 <!-- PARAMETERS --> 1560 <h4>Parameters</h4> 1561 <dl> 1562 <div> 1563 <div> 1564 <dt> 1565 <var>details</var> 1566 <em> 1567 1568 <!-- TYPE --> 1569 <div style="display:inline"> 1570 ( 1571 <span class="optional" style="display: none; ">optional</span> 1572 <span class="enum" style="display: none; ">enumerated</span> 1573 <span id="typeTemplate"> 1574 <span style="display: none; "> 1575 <a> Type</a> 1576 </span> 1577 <span> 1578 <span style="display: none; "> 1579 array of <span><span></span></span> 1580 </span> 1581 <span>object</span> 1582 <span style="display: none; "></span> 1583 </span> 1584 </span> 1585 ) 1586 </div> 1587 1588 </em> 1589 </dt> 1590 <dd class="todo"> 1591 Undocumented. 1592 </dd> 1593 <dd style="display: none; "> 1594 Description of this parameter from the json schema. 1595 </dd> 1596 <dd style="display: none; "> 1597 This parameter was added in version 1598 <b><span></span></b>. 1599 You must omit this parameter in earlier versions, 1600 and you may omit it in any version. If you require this 1601 parameter, the manifest key 1602 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1603 can ensure that your extension won't be run in an earlier browser version. 1604 </dd> 1605 1606 <!-- OBJECT PROPERTIES --> 1607 <dd> 1608 <dl> 1609 <div> 1610 <div> 1611 <dt> 1612 <var>tabId</var> 1613 <em> 1614 1615 <!-- TYPE --> 1616 <div style="display:inline"> 1617 ( 1618 <span class="optional">optional</span> 1619 <span class="enum" style="display: none; ">enumerated</span> 1620 <span id="typeTemplate"> 1621 <span style="display: none; "> 1622 <a> Type</a> 1623 </span> 1624 <span> 1625 <span style="display: none; "> 1626 array of <span><span></span></span> 1627 </span> 1628 <span>integer</span> 1629 <span style="display: none; "></span> 1630 </span> 1631 </span> 1632 ) 1633 </div> 1634 1635 </em> 1636 </dt> 1637 <dd class="todo" style="display: none; "> 1638 Undocumented. 1639 </dd> 1640 <dd>Defaults to the selected tab of the <a href="windows.html#current-window">current window</a>.</dd> 1641 <dd style="display: none; "> 1642 This parameter was added in version 1643 <b><span></span></b>. 1644 You must omit this parameter in earlier versions, 1645 and you may omit it in any version. If you require this 1646 parameter, the manifest key 1647 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1648 can ensure that your extension won't be run in an earlier browser version. 1649 </dd> 1650 1651 <!-- OBJECT PROPERTIES --> 1652 <dd style="display: none; "> 1653 <dl> 1654 <div> 1655 <div> 1656 </div> 1657 </div> 1658 </dl> 1659 </dd> 1660 1661 <!-- OBJECT METHODS --> 1662 <dd style="display: none; "> 1663 <div></div> 1664 </dd> 1665 1666 <!-- OBJECT EVENT FIELDS --> 1667 <dd style="display: none; "> 1668 <div></div> 1669 </dd> 1670 1671 <!-- FUNCTION PARAMETERS --> 1672 <dd style="display: none; "> 1673 <div></div> 1674 </dd> 1675 1676 </div> 1677 </div><div> 1678 <div> 1679 <dt> 1680 <var>text</var> 1681 <em> 1682 1683 <!-- TYPE --> 1684 <div style="display:inline"> 1685 ( 1686 <span class="optional" style="display: none; ">optional</span> 1687 <span class="enum" style="display: none; ">enumerated</span> 1688 <span id="typeTemplate"> 1689 <span style="display: none; "> 1690 <a> Type</a> 1691 </span> 1692 <span> 1693 <span style="display: none; "> 1694 array of <span><span></span></span> 1695 </span> 1696 <span>string</span> 1697 <span style="display: none; "></span> 1698 </span> 1699 </span> 1700 ) 1701 </div> 1702 1703 </em> 1704 </dt> 1705 <dd class="todo" style="display: none; "> 1706 Undocumented. 1707 </dd> 1708 <dd>The sidebar's badge text. The badge is displayed on top of the sidebar's icon on the mini tab. Any number of characters can be passed, but only about four can fit in the space.</dd> 1709 <dd style="display: none; "> 1710 This parameter was added in version 1711 <b><span></span></b>. 1712 You must omit this parameter in earlier versions, 1713 and you may omit it in any version. If you require this 1714 parameter, the manifest key 1715 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1716 can ensure that your extension won't be run in an earlier browser version. 1717 </dd> 1718 1719 <!-- OBJECT PROPERTIES --> 1720 <dd style="display: none; "> 1721 <dl> 1722 <div> 1723 <div> 1724 </div> 1725 </div> 1726 </dl> 1727 </dd> 1728 1729 <!-- OBJECT METHODS --> 1730 <dd style="display: none; "> 1731 <div></div> 1732 </dd> 1733 1734 <!-- OBJECT EVENT FIELDS --> 1735 <dd style="display: none; "> 1736 <div></div> 1737 </dd> 1738 1739 <!-- FUNCTION PARAMETERS --> 1740 <dd style="display: none; "> 1741 <div></div> 1742 </dd> 1743 1744 </div> 1745 </div> 1746 </dl> 1747 </dd> 1748 1749 <!-- OBJECT METHODS --> 1750 <dd style="display: none; "> 1751 <div></div> 1752 </dd> 1753 1754 <!-- OBJECT EVENT FIELDS --> 1755 <dd style="display: none; "> 1756 <div></div> 1757 </dd> 1758 1759 <!-- FUNCTION PARAMETERS --> 1760 <dd style="display: none; "> 1761 <div></div> 1762 </dd> 1763 1764 </div> 1765 </div> 1766 </dl> 1767 1768 <!-- RETURNS --> 1769 <h4 style="display: none; ">Returns</h4> 1770 <dl> 1771 <div style="display: none; "> 1772 <div> 1773 </div> 1774 </div> 1775 </dl> 1776 1777 <!-- CALLBACK --> 1778 <div style="display: none; "> 1779 <div> 1780 <h4>Callback function</h4> 1781 <p> 1782 The callback <em>parameter</em> should specify a function 1783 that looks like this: 1784 </p> 1785 <p> 1786 If you specify the <em>callback</em> parameter, it should 1787 specify a function that looks like this: 1788 </p> 1789 1790 <!-- Note: intentionally longer 80 columns --> 1791 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1792 <dl> 1793 <div> 1794 <div> 1795 </div> 1796 </div> 1797 </dl> 1798 </div> 1799 </div> 1800 1801 <!-- MIN_VERSION --> 1802 <p style="display: none; "> 1803 This function was added in version <b><span></span></b>. 1804 If you require this function, the manifest key 1805 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1806 can ensure that your extension won't be run in an earlier browser version. 1807 </p> 1808 </div> <!-- /description --> 1809 1810 </div><div class="apiItem"> 1811 <a name="method-setIcon"></a> <!-- method-anchor --> 1812 <h4>setIcon</h4> 1813 1814 <div class="summary"><span style="display: none; ">void</span> 1815 <!-- Note: intentionally longer 80 columns --> 1816 <span>chrome.experimental.sidebar.setIcon</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1817 <var><span>details</span></var></span>)</div> 1818 1819 <div class="description"> 1820 <p class="todo" style="display: none; ">Undocumented.</p> 1821 <p>Sets sidebar's mini tab icon for the specified tab.</p> 1822 1823 <!-- PARAMETERS --> 1824 <h4>Parameters</h4> 1825 <dl> 1826 <div> 1827 <div> 1828 <dt> 1829 <var>details</var> 1830 <em> 1831 1832 <!-- TYPE --> 1833 <div style="display:inline"> 1834 ( 1835 <span class="optional" style="display: none; ">optional</span> 1836 <span class="enum" style="display: none; ">enumerated</span> 1837 <span id="typeTemplate"> 1838 <span style="display: none; "> 1839 <a> Type</a> 1840 </span> 1841 <span> 1842 <span style="display: none; "> 1843 array of <span><span></span></span> 1844 </span> 1845 <span>object</span> 1846 <span style="display: none; "></span> 1847 </span> 1848 </span> 1849 ) 1850 </div> 1851 1852 </em> 1853 </dt> 1854 <dd class="todo"> 1855 Undocumented. 1856 </dd> 1857 <dd style="display: none; "> 1858 Description of this parameter from the json schema. 1859 </dd> 1860 <dd style="display: none; "> 1861 This parameter was added in version 1862 <b><span></span></b>. 1863 You must omit this parameter in earlier versions, 1864 and you may omit it in any version. If you require this 1865 parameter, the manifest key 1866 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1867 can ensure that your extension won't be run in an earlier browser version. 1868 </dd> 1869 1870 <!-- OBJECT PROPERTIES --> 1871 <dd> 1872 <dl> 1873 <div> 1874 <div> 1875 <dt> 1876 <var>tabId</var> 1877 <em> 1878 1879 <!-- TYPE --> 1880 <div style="display:inline"> 1881 ( 1882 <span class="optional">optional</span> 1883 <span class="enum" style="display: none; ">enumerated</span> 1884 <span id="typeTemplate"> 1885 <span style="display: none; "> 1886 <a> Type</a> 1887 </span> 1888 <span> 1889 <span style="display: none; "> 1890 array of <span><span></span></span> 1891 </span> 1892 <span>integer</span> 1893 <span style="display: none; "></span> 1894 </span> 1895 </span> 1896 ) 1897 </div> 1898 1899 </em> 1900 </dt> 1901 <dd class="todo" style="display: none; "> 1902 Undocumented. 1903 </dd> 1904 <dd>Defaults to the selected tab of the <a href="windows.html#current-window">current window</a>.</dd> 1905 <dd style="display: none; "> 1906 This parameter was added in version 1907 <b><span></span></b>. 1908 You must omit this parameter in earlier versions, 1909 and you may omit it in any version. If you require this 1910 parameter, the manifest key 1911 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1912 can ensure that your extension won't be run in an earlier browser version. 1913 </dd> 1914 1915 <!-- OBJECT PROPERTIES --> 1916 <dd style="display: none; "> 1917 <dl> 1918 <div> 1919 <div> 1920 </div> 1921 </div> 1922 </dl> 1923 </dd> 1924 1925 <!-- OBJECT METHODS --> 1926 <dd style="display: none; "> 1927 <div></div> 1928 </dd> 1929 1930 <!-- OBJECT EVENT FIELDS --> 1931 <dd style="display: none; "> 1932 <div></div> 1933 </dd> 1934 1935 <!-- FUNCTION PARAMETERS --> 1936 <dd style="display: none; "> 1937 <div></div> 1938 </dd> 1939 1940 </div> 1941 </div><div> 1942 <div> 1943 <dt> 1944 <var>imageData</var> 1945 <em> 1946 1947 <!-- TYPE --> 1948 <div style="display:inline"> 1949 ( 1950 <span class="optional">optional</span> 1951 <span class="enum" style="display: none; ">enumerated</span> 1952 <span id="typeTemplate"> 1953 <span style="display: none; "> 1954 <a> Type</a> 1955 </span> 1956 <span> 1957 <span style="display: none; "> 1958 array of <span><span></span></span> 1959 </span> 1960 <span>ImageData</span> 1961 <span style="display: none; "></span> 1962 </span> 1963 </span> 1964 ) 1965 </div> 1966 1967 </em> 1968 </dt> 1969 <dd class="todo" style="display: none; "> 1970 Undocumented. 1971 </dd> 1972 <dd>Pixel data for an image to show on the sidebar's mini tab. Must be an ImageData object (for example, from a <code>canvas</code> element). Only one of the imagePath/imageData parameters all owed. The extension's icon is used by default. The preferred size of the icon is 16x16 pixels, any other size will be scaled to 16x16.</dd> 1973 <dd style="display: none; "> 1974 This parameter was added in version 1975 <b><span></span></b>. 1976 You must omit this parameter in earlier versions, 1977 and you may omit it in any version. If you require this 1978 parameter, the manifest key 1979 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1980 can ensure that your extension won't be run in an earlier browser version. 1981 </dd> 1982 1983 <!-- OBJECT PROPERTIES --> 1984 <dd> 1985 <dl> 1986 <div style="display: none; "> 1987 <div> 1988 </div> 1989 </div> 1990 </dl> 1991 </dd> 1992 1993 <!-- OBJECT METHODS --> 1994 <dd style="display: none; "> 1995 <div></div> 1996 </dd> 1997 1998 <!-- OBJECT EVENT FIELDS --> 1999 <dd style="display: none; "> 2000 <div></div> 2001 </dd> 2002 2003 <!-- FUNCTION PARAMETERS --> 2004 <dd style="display: none; "> 2005 <div></div> 2006 </dd> 2007 2008 </div> 2009 </div><div> 2010 <div> 2011 <dt> 2012 <var>path</var> 2013 <em> 2014 2015 <!-- TYPE --> 2016 <div style="display:inline"> 2017 ( 2018 <span class="optional">optional</span> 2019 <span class="enum" style="display: none; ">enumerated</span> 2020 <span id="typeTemplate"> 2021 <span style="display: none; "> 2022 <a> Type</a> 2023 </span> 2024 <span> 2025 <span style="display: none; "> 2026 array of <span><span></span></span> 2027 </span> 2028 <span>string</span> 2029 <span style="display: none; "></span> 2030 </span> 2031 </span> 2032 ) 2033 </div> 2034 2035 </em> 2036 </dt> 2037 <dd class="todo" style="display: none; "> 2038 Undocumented. 2039 </dd> 2040 <dd>Relative path to an image in the extension to show on the sidebar's mini tab. Only one of the imagePath/imageData parameters all owed. The extension's icon is used by default. The preferred size of the icon is 16x16 pixels, any other size will be scaled to 16x16.</dd> 2041 <dd style="display: none; "> 2042 This parameter was added in version 2043 <b><span></span></b>. 2044 You must omit this parameter in earlier versions, 2045 and you may omit it in any version. If you require this 2046 parameter, the manifest key 2047 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2048 can ensure that your extension won't be run in an earlier browser version. 2049 </dd> 2050 2051 <!-- OBJECT PROPERTIES --> 2052 <dd style="display: none; "> 2053 <dl> 2054 <div> 2055 <div> 2056 </div> 2057 </div> 2058 </dl> 2059 </dd> 2060 2061 <!-- OBJECT METHODS --> 2062 <dd style="display: none; "> 2063 <div></div> 2064 </dd> 2065 2066 <!-- OBJECT EVENT FIELDS --> 2067 <dd style="display: none; "> 2068 <div></div> 2069 </dd> 2070 2071 <!-- FUNCTION PARAMETERS --> 2072 <dd style="display: none; "> 2073 <div></div> 2074 </dd> 2075 2076 </div> 2077 </div> 2078 </dl> 2079 </dd> 2080 2081 <!-- OBJECT METHODS --> 2082 <dd style="display: none; "> 2083 <div></div> 2084 </dd> 2085 2086 <!-- OBJECT EVENT FIELDS --> 2087 <dd style="display: none; "> 2088 <div></div> 2089 </dd> 2090 2091 <!-- FUNCTION PARAMETERS --> 2092 <dd style="display: none; "> 2093 <div></div> 2094 </dd> 2095 2096 </div> 2097 </div> 2098 </dl> 2099 2100 <!-- RETURNS --> 2101 <h4 style="display: none; ">Returns</h4> 2102 <dl> 2103 <div style="display: none; "> 2104 <div> 2105 </div> 2106 </div> 2107 </dl> 2108 2109 <!-- CALLBACK --> 2110 <div style="display: none; "> 2111 <div> 2112 <h4>Callback function</h4> 2113 <p> 2114 The callback <em>parameter</em> should specify a function 2115 that looks like this: 2116 </p> 2117 <p> 2118 If you specify the <em>callback</em> parameter, it should 2119 specify a function that looks like this: 2120 </p> 2121 2122 <!-- Note: intentionally longer 80 columns --> 2123 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 2124 <dl> 2125 <div> 2126 <div> 2127 </div> 2128 </div> 2129 </dl> 2130 </div> 2131 </div> 2132 2133 <!-- MIN_VERSION --> 2134 <p style="display: none; "> 2135 This function was added in version <b><span></span></b>. 2136 If you require this function, the manifest key 2137 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2138 can ensure that your extension won't be run in an earlier browser version. 2139 </p> 2140 </div> <!-- /description --> 2141 2142 </div><div class="apiItem"> 2143 <a name="method-setTitle"></a> <!-- method-anchor --> 2144 <h4>setTitle</h4> 2145 2146 <div class="summary"><span style="display: none; ">void</span> 2147 <!-- Note: intentionally longer 80 columns --> 2148 <span>chrome.experimental.sidebar.setTitle</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 2149 <var><span>details</span></var></span>)</div> 2150 2151 <div class="description"> 2152 <p class="todo" style="display: none; ">Undocumented.</p> 2153 <p>Sets sidebar's mini tab title for the specified tab.</p> 2154 2155 <!-- PARAMETERS --> 2156 <h4>Parameters</h4> 2157 <dl> 2158 <div> 2159 <div> 2160 <dt> 2161 <var>details</var> 2162 <em> 2163 2164 <!-- TYPE --> 2165 <div style="display:inline"> 2166 ( 2167 <span class="optional" style="display: none; ">optional</span> 2168 <span class="enum" style="display: none; ">enumerated</span> 2169 <span id="typeTemplate"> 2170 <span style="display: none; "> 2171 <a> Type</a> 2172 </span> 2173 <span> 2174 <span style="display: none; "> 2175 array of <span><span></span></span> 2176 </span> 2177 <span>object</span> 2178 <span style="display: none; "></span> 2179 </span> 2180 </span> 2181 ) 2182 </div> 2183 2184 </em> 2185 </dt> 2186 <dd class="todo"> 2187 Undocumented. 2188 </dd> 2189 <dd style="display: none; "> 2190 Description of this parameter from the json schema. 2191 </dd> 2192 <dd style="display: none; "> 2193 This parameter was added in version 2194 <b><span></span></b>. 2195 You must omit this parameter in earlier versions, 2196 and you may omit it in any version. If you require this 2197 parameter, the manifest key 2198 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2199 can ensure that your extension won't be run in an earlier browser version. 2200 </dd> 2201 2202 <!-- OBJECT PROPERTIES --> 2203 <dd> 2204 <dl> 2205 <div> 2206 <div> 2207 <dt> 2208 <var>tabId</var> 2209 <em> 2210 2211 <!-- TYPE --> 2212 <div style="display:inline"> 2213 ( 2214 <span class="optional">optional</span> 2215 <span class="enum" style="display: none; ">enumerated</span> 2216 <span id="typeTemplate"> 2217 <span style="display: none; "> 2218 <a> Type</a> 2219 </span> 2220 <span> 2221 <span style="display: none; "> 2222 array of <span><span></span></span> 2223 </span> 2224 <span>integer</span> 2225 <span style="display: none; "></span> 2226 </span> 2227 </span> 2228 ) 2229 </div> 2230 2231 </em> 2232 </dt> 2233 <dd class="todo" style="display: none; "> 2234 Undocumented. 2235 </dd> 2236 <dd>Defaults to the selected tab of the <a href="windows.html#current-window">current window</a>.</dd> 2237 <dd style="display: none; "> 2238 This parameter was added in version 2239 <b><span></span></b>. 2240 You must omit this parameter in earlier versions, 2241 and you may omit it in any version. If you require this 2242 parameter, the manifest key 2243 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2244 can ensure that your extension won't be run in an earlier browser version. 2245 </dd> 2246 2247 <!-- OBJECT PROPERTIES --> 2248 <dd style="display: none; "> 2249 <dl> 2250 <div> 2251 <div> 2252 </div> 2253 </div> 2254 </dl> 2255 </dd> 2256 2257 <!-- OBJECT METHODS --> 2258 <dd style="display: none; "> 2259 <div></div> 2260 </dd> 2261 2262 <!-- OBJECT EVENT FIELDS --> 2263 <dd style="display: none; "> 2264 <div></div> 2265 </dd> 2266 2267 <!-- FUNCTION PARAMETERS --> 2268 <dd style="display: none; "> 2269 <div></div> 2270 </dd> 2271 2272 </div> 2273 </div><div> 2274 <div> 2275 <dt> 2276 <var>title</var> 2277 <em> 2278 2279 <!-- TYPE --> 2280 <div style="display:inline"> 2281 ( 2282 <span class="optional" style="display: none; ">optional</span> 2283 <span class="enum" style="display: none; ">enumerated</span> 2284 <span id="typeTemplate"> 2285 <span style="display: none; "> 2286 <a> Type</a> 2287 </span> 2288 <span> 2289 <span style="display: none; "> 2290 array of <span><span></span></span> 2291 </span> 2292 <span>string</span> 2293 <span style="display: none; "></span> 2294 </span> 2295 </span> 2296 ) 2297 </div> 2298 2299 </em> 2300 </dt> 2301 <dd class="todo" style="display: none; "> 2302 Undocumented. 2303 </dd> 2304 <dd>The sidebar's title. It is displayed in a tooltip over the sidebar's mini tab.</dd> 2305 <dd style="display: none; "> 2306 This parameter was added in version 2307 <b><span></span></b>. 2308 You must omit this parameter in earlier versions, 2309 and you may omit it in any version. If you require this 2310 parameter, the manifest key 2311 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2312 can ensure that your extension won't be run in an earlier browser version. 2313 </dd> 2314 2315 <!-- OBJECT PROPERTIES --> 2316 <dd style="display: none; "> 2317 <dl> 2318 <div> 2319 <div> 2320 </div> 2321 </div> 2322 </dl> 2323 </dd> 2324 2325 <!-- OBJECT METHODS --> 2326 <dd style="display: none; "> 2327 <div></div> 2328 </dd> 2329 2330 <!-- OBJECT EVENT FIELDS --> 2331 <dd style="display: none; "> 2332 <div></div> 2333 </dd> 2334 2335 <!-- FUNCTION PARAMETERS --> 2336 <dd style="display: none; "> 2337 <div></div> 2338 </dd> 2339 2340 </div> 2341 </div> 2342 </dl> 2343 </dd> 2344 2345 <!-- OBJECT METHODS --> 2346 <dd style="display: none; "> 2347 <div></div> 2348 </dd> 2349 2350 <!-- OBJECT EVENT FIELDS --> 2351 <dd style="display: none; "> 2352 <div></div> 2353 </dd> 2354 2355 <!-- FUNCTION PARAMETERS --> 2356 <dd style="display: none; "> 2357 <div></div> 2358 </dd> 2359 2360 </div> 2361 </div> 2362 </dl> 2363 2364 <!-- RETURNS --> 2365 <h4 style="display: none; ">Returns</h4> 2366 <dl> 2367 <div style="display: none; "> 2368 <div> 2369 </div> 2370 </div> 2371 </dl> 2372 2373 <!-- CALLBACK --> 2374 <div style="display: none; "> 2375 <div> 2376 <h4>Callback function</h4> 2377 <p> 2378 The callback <em>parameter</em> should specify a function 2379 that looks like this: 2380 </p> 2381 <p> 2382 If you specify the <em>callback</em> parameter, it should 2383 specify a function that looks like this: 2384 </p> 2385 2386 <!-- Note: intentionally longer 80 columns --> 2387 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 2388 <dl> 2389 <div> 2390 <div> 2391 </div> 2392 </div> 2393 </dl> 2394 </div> 2395 </div> 2396 2397 <!-- MIN_VERSION --> 2398 <p style="display: none; "> 2399 This function was added in version <b><span></span></b>. 2400 If you require this function, the manifest key 2401 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2402 can ensure that your extension won't be run in an earlier browser version. 2403 </p> 2404 </div> <!-- /description --> 2405 2406 </div><div class="apiItem"> 2407 <a name="method-show"></a> <!-- method-anchor --> 2408 <h4>show</h4> 2409 2410 <div class="summary"><span style="display: none; ">void</span> 2411 <!-- Note: intentionally longer 80 columns --> 2412 <span>chrome.experimental.sidebar.show</span>(<span class="optional"><span style="display: none; ">, </span><span>object</span> 2413 <var><span>details</span></var></span>)</div> 2414 2415 <div class="description"> 2416 <p class="todo" style="display: none; ">Undocumented.</p> 2417 <p>Shows sidebar mini tab (in 'shown' state) for the specified tab. Has no effect if already expanded, otherwise changes status to 'shown'.</p> 2418 2419 <!-- PARAMETERS --> 2420 <h4>Parameters</h4> 2421 <dl> 2422 <div> 2423 <div> 2424 <dt> 2425 <var>details</var> 2426 <em> 2427 2428 <!-- TYPE --> 2429 <div style="display:inline"> 2430 ( 2431 <span class="optional">optional</span> 2432 <span class="enum" style="display: none; ">enumerated</span> 2433 <span id="typeTemplate"> 2434 <span style="display: none; "> 2435 <a> Type</a> 2436 </span> 2437 <span> 2438 <span style="display: none; "> 2439 array of <span><span></span></span> 2440 </span> 2441 <span>object</span> 2442 <span style="display: none; "></span> 2443 </span> 2444 </span> 2445 ) 2446 </div> 2447 2448 </em> 2449 </dt> 2450 <dd class="todo"> 2451 Undocumented. 2452 </dd> 2453 <dd style="display: none; "> 2454 Description of this parameter from the json schema. 2455 </dd> 2456 <dd style="display: none; "> 2457 This parameter was added in version 2458 <b><span></span></b>. 2459 You must omit this parameter in earlier versions, 2460 and you may omit it in any version. If you require this 2461 parameter, the manifest key 2462 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2463 can ensure that your extension won't be run in an earlier browser version. 2464 </dd> 2465 2466 <!-- OBJECT PROPERTIES --> 2467 <dd> 2468 <dl> 2469 <div> 2470 <div> 2471 <dt> 2472 <var>tabId</var> 2473 <em> 2474 2475 <!-- TYPE --> 2476 <div style="display:inline"> 2477 ( 2478 <span class="optional">optional</span> 2479 <span class="enum" style="display: none; ">enumerated</span> 2480 <span id="typeTemplate"> 2481 <span style="display: none; "> 2482 <a> Type</a> 2483 </span> 2484 <span> 2485 <span style="display: none; "> 2486 array of <span><span></span></span> 2487 </span> 2488 <span>integer</span> 2489 <span style="display: none; "></span> 2490 </span> 2491 </span> 2492 ) 2493 </div> 2494 2495 </em> 2496 </dt> 2497 <dd class="todo" style="display: none; "> 2498 Undocumented. 2499 </dd> 2500 <dd>Defaults to the selected tab of the <a href="windows.html#current-window">current window</a>.</dd> 2501 <dd style="display: none; "> 2502 This parameter was added in version 2503 <b><span></span></b>. 2504 You must omit this parameter in earlier versions, 2505 and you may omit it in any version. If you require this 2506 parameter, the manifest key 2507 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2508 can ensure that your extension won't be run in an earlier browser version. 2509 </dd> 2510 2511 <!-- OBJECT PROPERTIES --> 2512 <dd style="display: none; "> 2513 <dl> 2514 <div> 2515 <div> 2516 </div> 2517 </div> 2518 </dl> 2519 </dd> 2520 2521 <!-- OBJECT METHODS --> 2522 <dd style="display: none; "> 2523 <div></div> 2524 </dd> 2525 2526 <!-- OBJECT EVENT FIELDS --> 2527 <dd style="display: none; "> 2528 <div></div> 2529 </dd> 2530 2531 <!-- FUNCTION PARAMETERS --> 2532 <dd style="display: none; "> 2533 <div></div> 2534 </dd> 2535 2536 </div> 2537 </div> 2538 </dl> 2539 </dd> 2540 2541 <!-- OBJECT METHODS --> 2542 <dd style="display: none; "> 2543 <div></div> 2544 </dd> 2545 2546 <!-- OBJECT EVENT FIELDS --> 2547 <dd style="display: none; "> 2548 <div></div> 2549 </dd> 2550 2551 <!-- FUNCTION PARAMETERS --> 2552 <dd style="display: none; "> 2553 <div></div> 2554 </dd> 2555 2556 </div> 2557 </div> 2558 </dl> 2559 2560 <!-- RETURNS --> 2561 <h4 style="display: none; ">Returns</h4> 2562 <dl> 2563 <div style="display: none; "> 2564 <div> 2565 </div> 2566 </div> 2567 </dl> 2568 2569 <!-- CALLBACK --> 2570 <div style="display: none; "> 2571 <div> 2572 <h4>Callback function</h4> 2573 <p> 2574 The callback <em>parameter</em> should specify a function 2575 that looks like this: 2576 </p> 2577 <p> 2578 If you specify the <em>callback</em> parameter, it should 2579 specify a function that looks like this: 2580 </p> 2581 2582 <!-- Note: intentionally longer 80 columns --> 2583 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 2584 <dl> 2585 <div> 2586 <div> 2587 </div> 2588 </div> 2589 </dl> 2590 </div> 2591 </div> 2592 2593 <!-- MIN_VERSION --> 2594 <p style="display: none; "> 2595 This function was added in version <b><span></span></b>. 2596 If you require this function, the manifest key 2597 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2598 can ensure that your extension won't be run in an earlier browser version. 2599 </p> 2600 </div> <!-- /description --> 2601 2602 </div> <!-- /apiItem --> 2603 2604 </div> <!-- /apiGroup --> 2605 2606 <!-- EVENTS --> 2607 <div id="eventsTemplate" class="apiGroup"> 2608 <a name="global-events"></a> 2609 <h3>Events</h3> 2610 <!-- iterates over all events --> 2611 <div class="apiItem"> 2612 <a name="event-onStateChanged"></a> 2613 <h4>onStateChanged</h4> 2614 2615 <div class="summary"> 2616 <!-- Note: intentionally longer 80 columns --> 2617 <span class="subdued">chrome.experimental.sidebar.</span><span>onStateChanged</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 2618 </div> 2619 2620 <div class="description"> 2621 <p class="todo" style="display: none; ">Undocumented.</p> 2622 <p>Notifies about sidebar state changes.</p> 2623 2624 <!-- PARAMETERS --> 2625 <div> 2626 <h4>Parameters</h4> 2627 <dl> 2628 <div> 2629 <div> 2630 <dt> 2631 <var>details</var> 2632 <em> 2633 2634 <!-- TYPE --> 2635 <div style="display:inline"> 2636 ( 2637 <span class="optional" style="display: none; ">optional</span> 2638 <span class="enum" style="display: none; ">enumerated</span> 2639 <span id="typeTemplate"> 2640 <span style="display: none; "> 2641 <a> Type</a> 2642 </span> 2643 <span> 2644 <span style="display: none; "> 2645 array of <span><span></span></span> 2646 </span> 2647 <span>object</span> 2648 <span style="display: none; "></span> 2649 </span> 2650 </span> 2651 ) 2652 </div> 2653 2654 </em> 2655 </dt> 2656 <dd class="todo"> 2657 Undocumented. 2658 </dd> 2659 <dd style="display: none; "> 2660 Description of this parameter from the json schema. 2661 </dd> 2662 <dd style="display: none; "> 2663 This parameter was added in version 2664 <b><span></span></b>. 2665 You must omit this parameter in earlier versions, 2666 and you may omit it in any version. If you require this 2667 parameter, the manifest key 2668 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2669 can ensure that your extension won't be run in an earlier browser version. 2670 </dd> 2671 2672 <!-- OBJECT PROPERTIES --> 2673 <dd> 2674 <dl> 2675 <div> 2676 <div> 2677 <dt> 2678 <var>tabId</var> 2679 <em> 2680 2681 <!-- TYPE --> 2682 <div style="display:inline"> 2683 ( 2684 <span class="optional" style="display: none; ">optional</span> 2685 <span class="enum" style="display: none; ">enumerated</span> 2686 <span id="typeTemplate"> 2687 <span style="display: none; "> 2688 <a> Type</a> 2689 </span> 2690 <span> 2691 <span style="display: none; "> 2692 array of <span><span></span></span> 2693 </span> 2694 <span>integer</span> 2695 <span style="display: none; "></span> 2696 </span> 2697 </span> 2698 ) 2699 </div> 2700 2701 </em> 2702 </dt> 2703 <dd class="todo"> 2704 Undocumented. 2705 </dd> 2706 <dd style="display: none; "> 2707 Description of this parameter from the json schema. 2708 </dd> 2709 <dd style="display: none; "> 2710 This parameter was added in version 2711 <b><span></span></b>. 2712 You must omit this parameter in earlier versions, 2713 and you may omit it in any version. If you require this 2714 parameter, the manifest key 2715 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2716 can ensure that your extension won't be run in an earlier browser version. 2717 </dd> 2718 2719 <!-- OBJECT PROPERTIES --> 2720 <dd style="display: none; "> 2721 <dl> 2722 <div> 2723 <div> 2724 </div> 2725 </div> 2726 </dl> 2727 </dd> 2728 2729 <!-- OBJECT METHODS --> 2730 <dd style="display: none; "> 2731 <div></div> 2732 </dd> 2733 2734 <!-- OBJECT EVENT FIELDS --> 2735 <dd style="display: none; "> 2736 <div></div> 2737 </dd> 2738 2739 <!-- FUNCTION PARAMETERS --> 2740 <dd style="display: none; "> 2741 <div></div> 2742 </dd> 2743 2744 </div> 2745 </div><div> 2746 <div> 2747 <dt> 2748 <var>state</var> 2749 <em> 2750 2751 <!-- TYPE --> 2752 <div style="display:inline"> 2753 ( 2754 <span class="optional" style="display: none; ">optional</span> 2755 <span class="enum">enumerated</span> 2756 <span id="typeTemplate"> 2757 <span style="display: none; "> 2758 <a> Type</a> 2759 </span> 2760 <span> 2761 <span style="display: none; "> 2762 array of <span><span></span></span> 2763 </span> 2764 <span>string</span> 2765 <span>["hidden", "shown", "active"]</span> 2766 </span> 2767 </span> 2768 ) 2769 </div> 2770 2771 </em> 2772 </dt> 2773 <dd class="todo"> 2774 Undocumented. 2775 </dd> 2776 <dd style="display: none; "> 2777 Description of this parameter from the json schema. 2778 </dd> 2779 <dd style="display: none; "> 2780 This parameter was added in version 2781 <b><span></span></b>. 2782 You must omit this parameter in earlier versions, 2783 and you may omit it in any version. If you require this 2784 parameter, the manifest key 2785 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2786 can ensure that your extension won't be run in an earlier browser version. 2787 </dd> 2788 2789 <!-- OBJECT PROPERTIES --> 2790 <dd style="display: none; "> 2791 <dl> 2792 <div> 2793 <div> 2794 </div> 2795 </div> 2796 </dl> 2797 </dd> 2798 2799 <!-- OBJECT METHODS --> 2800 <dd style="display: none; "> 2801 <div></div> 2802 </dd> 2803 2804 <!-- OBJECT EVENT FIELDS --> 2805 <dd style="display: none; "> 2806 <div></div> 2807 </dd> 2808 2809 <!-- FUNCTION PARAMETERS --> 2810 <dd style="display: none; "> 2811 <div></div> 2812 </dd> 2813 2814 </div> 2815 </div> 2816 </dl> 2817 </dd> 2818 2819 <!-- OBJECT METHODS --> 2820 <dd style="display: none; "> 2821 <div></div> 2822 </dd> 2823 2824 <!-- OBJECT EVENT FIELDS --> 2825 <dd style="display: none; "> 2826 <div></div> 2827 </dd> 2828 2829 <!-- FUNCTION PARAMETERS --> 2830 <dd style="display: none; "> 2831 <div></div> 2832 </dd> 2833 2834 </div> 2835 </div> 2836 </dl> 2837 </div> 2838 </div> <!-- /decription --> 2839 2840 </div> <!-- /apiItem --> 2841 2842 </div> <!-- /apiGroup --> 2843 2844 <!-- TYPES --> 2845 <div class="apiGroup" style="display: none; "> 2846 <a name="types"></a> 2847 <h3 id="types">Types</h3> 2848 2849 <!-- iterates over all types --> 2850 <div class="apiItem"> 2851 <a></a> 2852 <h4>type name</h4> 2853 2854 <div> 2855 </div> 2856 2857 </div> <!-- /apiItem --> 2858 2859 </div> <!-- /apiGroup --> 2860 2861 </div> <!-- /apiPage --> 2862 </div> <!-- /gc-pagecontent --> 2863 </div> <!-- /g-section --> 2864 </div> <!-- /codesiteContent --> 2865 <div id="gc-footer" --=""> 2866 <div class="text"> 2867 <p> 2868 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 2869 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 2870 Attribution 3.0 License</a>, and code samples are licensed under the 2871 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 2872 </p> 2873 <p> 2874 2011 Google 2875 </p> 2876 2877 <!-- begin analytics --> 2878 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 2879 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 2880 2881 <script type="text/javascript"> 2882 // chrome doc tracking 2883 try { 2884 var engdocs = _gat._getTracker("YT-10763712-2"); 2885 engdocs._trackPageview(); 2886 } catch(err) {} 2887 2888 // code.google.com site-wide tracking 2889 try { 2890 _uacct="UA-18071-1"; 2891 _uanchor=1; 2892 _uff=0; 2893 urchinTracker(); 2894 } 2895 catch(e) {/* urchinTracker not available. */} 2896 </script> 2897 <!-- end analytics --> 2898 </div> 2899 </div> <!-- /gc-footer --> 2900 </div> <!-- /gc-container --> 2901 </body></html> 2902
