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