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