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>Page Actions - Google Chrome Extensions - Google Code</title></head> 20 <body> <div id="gc-container" class="labs"> 21 <div id="devModeWarning"> 22 You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. 23 </div> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 25 <!-- In particular, sub-templates that recurse, must be used by allowing 26 jstemplate to make a copy of the template in this section which 27 are not operated on by way of the jsskip="true" --> 28 <div style="display:none"> 29 30 <!-- VALUE --> 31 <div id="valueTemplate"> 32 <dt> 33 <var>paramName</var> 34 <em> 35 36 <!-- TYPE --> 37 <div style="display:inline"> 38 ( 39 <span class="optional">optional</span> 40 <span class="enum">enumerated</span> 41 <span id="typeTemplate"> 42 <span> 43 <a> Type</a> 44 </span> 45 <span> 46 <span> 47 array of <span><span></span></span> 48 </span> 49 <span>paramType</span> 50 <span></span> 51 </span> 52 </span> 53 ) 54 </div> 55 56 </em> 57 </dt> 58 <dd class="todo"> 59 Undocumented. 60 </dd> 61 <dd> 62 Description of this parameter from the json schema. 63 </dd> 64 <dd> 65 This parameter was added in version 66 <b><span></span></b>. 67 You must omit this parameter in earlier versions, 68 and you may omit it in any version. If you require this 69 parameter, the manifest key 70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 71 can ensure that your extension won't be run in an earlier browser version. 72 </dd> 73 74 <!-- OBJECT PROPERTIES --> 75 <dd> 76 <dl> 77 <div> 78 <div> 79 </div> 80 </div> 81 </dl> 82 </dd> 83 84 <!-- OBJECT METHODS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 <!-- OBJECT EVENT FIELDS --> 90 <dd> 91 <div></div> 92 </dd> 93 94 <!-- FUNCTION PARAMETERS --> 95 <dd> 96 <div></div> 97 </dd> 98 99 </div> <!-- /VALUE --> 100 101 <div id="functionParametersTemplate"> 102 <h5>Parameters</h5> 103 <dl> 104 <div> 105 <div> 106 </div> 107 </div> 108 </dl> 109 </div> 110 </div> <!-- /SUBTEMPLATES --> 111 112 <a id="top"></a> 113 <div id="skipto"> 114 <a href="#gc-pagecontent">Skip to page content</a> 115 <a href="#gc-toc">Skip to main navigation</a> 116 </div> 117 <!-- API HEADER --> 118 <table id="header" width="100%" cellspacing="0" border="0"> 119 <tbody><tr> 120 <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td> 121 <td valign="middle" width="100%" style="padding-left:0.6em;"> 122 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 123 <div id="gsc-search-box"> 124 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 125 <input type="hidden" name="ie" value="UTF-8"> 126 <input type="text" name="q" value="" size="55"> 127 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 128 <br> 129 <span class="greytext">e.g. "page action" or "tabs"</span> 130 </div> 131 </form> 132 133 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 134 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 136 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 137 </td> 138 </tr> 139 </tbody></table> 140 141 <div id="codesiteContent" class=""> 142 143 <a id="gc-topnav-anchor"></a> 144 <div id="gc-topnav"> 145 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 146 <ul id="home" class="gc-topnav-tabs"> 147 <li id="home_link"> 148 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 149 </li> 150 <li id="docs_link"> 151 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 152 </li> 153 <li id="faq_link"> 154 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 155 </li> 156 <li id="samples_link"> 157 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 158 </li> 159 <li id="group_link"> 160 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 161 </li> 162 </ul> 163 </div> <!-- end gc-topnav --> 164 165 <div class="g-section g-tpl-170"> 166 <!-- SIDENAV --> 167 <div class="g-unit g-first" id="gc-toc"> 168 <ul> 169 <li><a href="getstarted.html">Getting Started</a></li> 170 <li><a href="overview.html">Overview</a></li> 171 <li><a href="whats_new.html">What's New?</a></li> 172 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 173 <ul> 174 <li>Browser UI 175 <ul> 176 <li><a href="browserAction.html">Browser Actions</a></li> 177 <li><a href="contextMenus.html">Context Menus</a></li> 178 <li><a href="notifications.html">Desktop Notifications</a></li> 179 <li><a href="omnibox.html">Omnibox</a></li> 180 <li><a href="options.html">Options Pages</a></li> 181 <li><a href="override.html">Override Pages</a></li> 182 <li class="leftNavSelected">Page Actions</li> 183 </ul> 184 </li> 185 <li>Browser Interaction 186 <ul> 187 <li><a href="bookmarks.html">Bookmarks</a></li> 188 <li><a href="cookies.html">Cookies</a></li> 189 <li><a href="events.html">Events</a></li> 190 <li><a href="history.html">History</a></li> 191 <li><a href="management.html">Management</a></li> 192 <li><a href="tabs.html">Tabs</a></li> 193 <li><a href="windows.html">Windows</a></li> 194 </ul> 195 </li> 196 <li>Implementation 197 <ul> 198 <li><a href="a11y.html">Accessibility</a></li> 199 <li><a href="background_pages.html">Background Pages</a></li> 200 <li><a href="content_scripts.html">Content Scripts</a></li> 201 <li><a href="xhr.html">Cross-Origin XHR</a></li> 202 <li><a href="idle.html">Idle</a></li> 203 <li><a href="i18n.html">Internationalization</a></li> 204 <li><a href="messaging.html">Message Passing</a></li> 205 <li><a href="npapi.html">NPAPI Plugins</a></li> 206 </ul> 207 </li> 208 <li>Finishing 209 <ul> 210 <li><a href="hosting.html">Hosting</a></li> 211 <li><a href="external_extensions.html">Other Deployment Options</a></li> 212 </ul> 213 </li> 214 </ul> 215 </li> 216 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 217 <li><h2><a href="tutorials.html">Tutorials</a></h2> 218 <ul> 219 <li><a href="tut_debugging.html">Debugging</a></li> 220 <li><a href="tut_analytics.html">Google Analytics</a></li> 221 <li><a href="tut_oauth.html">OAuth</a></li> 222 </ul> 223 </li> 224 <li><h2>Reference</h2> 225 <ul> 226 <li>Formats 227 <ul> 228 <li><a href="manifest.html">Manifest Files</a></li> 229 <li><a href="match_patterns.html">Match Patterns</a></li> 230 </ul> 231 </li> 232 <li><a href="permission_warnings.html">Permission Warnings</a></li> 233 <li><a href="api_index.html">chrome.* APIs</a></li> 234 <li><a href="api_other.html">Other APIs</a></li> 235 </ul> 236 </li> 237 <li><h2><a href="samples.html">Samples</a></h2></li> 238 <div class="line"> </div> 239 <li><h2>More</h2> 240 <ul> 241 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 242 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 243 <li><a href="themes.html">Themes</a></li> 244 </ul> 245 </li> 246 </ul> 247 </div> 248 <script> 249 initToggles(); 250 </script> 251 252 <div class="g-unit" id="gc-pagecontent"> 253 <div id="pageTitle"> 254 <h1 class="page_title">Page Actions</h1> 255 </div> 256 <!-- TABLE OF CONTENTS --> 257 <div id="toc"> 258 <h2>Contents</h2> 259 <ol> 260 <li> 261 <a href="#manifest">Manifest</a> 262 <ol> 263 <li style="display: none; "> 264 <a>h3Name</a> 265 </li> 266 </ol> 267 </li><li> 268 <a href="#ui">Parts of the UI</a> 269 <ol> 270 <li style="display: none; "> 271 <a>h3Name</a> 272 </li> 273 </ol> 274 </li><li> 275 <a href="#tips">Tips</a> 276 <ol> 277 <li style="display: none; "> 278 <a>h3Name</a> 279 </li> 280 </ol> 281 </li><li> 282 <a href="#examples"> Examples </a> 283 <ol> 284 <li style="display: none; "> 285 <a>h3Name</a> 286 </li> 287 </ol> 288 </li> 289 <li> 290 <a href="#apiReference">API reference: chrome.pageAction</a> 291 <ol> 292 <li style="display: none; "> 293 <a href="#properties">Properties</a> 294 <ol> 295 <li> 296 <a href="#property-anchor">propertyName</a> 297 </li> 298 </ol> 299 </li> 300 <li> 301 <a href="#global-methods">Methods</a> 302 <ol> 303 <li> 304 <a href="#method-hide">hide</a> 305 </li><li> 306 <a href="#method-setIcon">setIcon</a> 307 </li><li> 308 <a href="#method-setPopup">setPopup</a> 309 </li><li> 310 <a href="#method-setTitle">setTitle</a> 311 </li><li> 312 <a href="#method-show">show</a> 313 </li> 314 </ol> 315 </li> 316 <li> 317 <a href="#global-events">Events</a> 318 <ol> 319 <li> 320 <a href="#event-onClicked">onClicked</a> 321 </li> 322 </ol> 323 </li> 324 <li style="display: none; "> 325 <a href="#types">Types</a> 326 <ol> 327 <li> 328 <a href="#id-anchor">id</a> 329 </li> 330 </ol> 331 </li> 332 </ol> 333 </li> 334 </ol> 335 </div> 336 <!-- /TABLE OF CONTENTS --> 337 338 <!-- Standard content lead-in for experimental API pages --> 339 <p id="classSummary" style="display: none; "> 340 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 341 </p> 342 343 <!-- STATIC CONTENT PLACEHOLDER --> 344 <div id="static"><div id="pageData-name" class="pageData">Page Actions</div> 345 346 <!-- BEGIN AUTHORED CONTENT --> 347 <p> 348 Use page actions to put icons inside the address bar. 349 Page actions represent actions 350 that can be taken on the current page, 351 but that aren't applicable to all pages. 352 Some examples: 353 </p> 354 <ul> 355 <li> Subscribe to this page's RSS feed </li> 356 <li> Make a slideshow out of this page's photos </li> 357 </ul> 358 359 <p> 360 The RSS icon in the following screenshot 361 represents a page action 362 that lets you subscribe to 363 the RSS feed for the current page. 364 </p> 365 366 <img src="images/page-action.png" width="361" height="79"> 367 368 <p> 369 If you want the extension's icon to always be visible, 370 use a <a href="browserAction.html">browser action</a> instead. 371 </p> 372 373 <p class="caution"> 374 <strong>Note:</strong> 375 Packaged apps cannot use page actions. 376 </p> 377 378 379 <h2 id="manifest">Manifest</h2> 380 381 <p> 382 Register your page action in the 383 <a href="manifest.html">extension manifest</a> 384 like this: 385 </p> 386 387 <pre>{ 388 "name": "My extension", 389 ... 390 <b>"page_action": { 391 "default_icon": "icons/foo.png", <em>// optional</em> 392 "default_title": "Do action", <em>// optional; shown in tooltip</em> 393 "default_popup": "popup.html" <em>// optional</em> 394 }</b>, 395 ... 396 }</pre> 397 398 <h2 id="ui">Parts of the UI</h2> 399 400 <p> 401 Like browser actions, 402 page actions can have an icon, 403 a tooltip, and popup; 404 they can't have badges, however. 405 In addition, page actions can appear and disappear. 406 You can find information about icons, tooltips, and popups 407 by reading about the 408 <a href="browserAction.html#ui">browser action UI</a>. 409 </p> 410 411 <p> 412 You make a page action appear and disappear using the 413 <a href="#method-show">show()</a> and 414 <a href="#method-hide">hide()</a> methods, respectively. 415 By default, a page action is hidden. 416 When you show it, you specify the tab 417 in which the icon should appear. 418 The icon remains visible 419 until the tab is closed 420 or starts displaying a different URL 421 (because the user clicks a link, for example). 422 </p> 423 424 <!-- [PENDING: We should discuss how tabs and page actions are related. All methods take a tab ID argument. How do you get that tab ID? What's the usual way of arranging the code that monitors pages? Point to examples.] --> 425 426 427 <h2 id="tips">Tips</h2> 428 429 <p>For the best visual impact, 430 follow these guidelines:</p> 431 432 <ul> 433 <li><b>Do</b> use page actions 434 for features that make sense 435 for only a few pages. 436 </li><li><b>Don't</b> use page actions 437 for features that make sense 438 for most pages. 439 Use <a href="browserAction.html">browser actions</a> instead. 440 </li><li><b>Don't</b> constantly animate your icon. 441 That's just annoying. 442 </li></ul> 443 444 445 <h2 id="examples"> Examples </h2> 446 447 <p> 448 You can find simple examples of using page actions in the 449 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/pageAction/">examples/api/pageAction</a> 450 directory. 451 For other examples and for help in viewing the source code, see 452 <a href="samples.html">Samples</a>. 453 </p> 454 455 <!-- END AUTHORED CONTENT --> 456 </div> 457 458 <!-- API PAGE --> 459 <div class="apiPage"> 460 <a name="apiReference"></a> 461 <h2>API reference: chrome.pageAction</h2> 462 463 <!-- PROPERTIES --> 464 <div class="apiGroup" style="display: none; "> 465 <a name="properties"></a> 466 <h3 id="properties">Properties</h3> 467 468 <div> 469 <a></a> 470 <h4>getLastError</h4> 471 <div class="summary"> 472 <!-- Note: intentionally longer 80 columns --> 473 <span>chrome.extension</span><span>lastError</span> 474 </div> 475 <div> 476 </div> 477 </div> 478 479 </div> <!-- /apiGroup --> 480 481 <!-- METHODS --> 482 <div id="methodsTemplate" class="apiGroup"> 483 <a name="global-methods"></a> 484 <h3>Methods</h3> 485 486 <!-- iterates over all functions --> 487 <div class="apiItem"> 488 <a name="method-hide"></a> <!-- method-anchor --> 489 <h4>hide</h4> 490 491 <div class="summary"><span style="display: none; ">void</span> 492 <!-- Note: intentionally longer 80 columns --> 493 <span>chrome.pageAction.hide</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 494 <var><span>tabId</span></var></span>)</div> 495 496 <div class="description"> 497 <p class="todo" style="display: none; ">Undocumented.</p> 498 <p>Hides the page action.</p> 499 500 <!-- PARAMETERS --> 501 <h4>Parameters</h4> 502 <dl> 503 <div> 504 <div> 505 <dt> 506 <var>tabId</var> 507 <em> 508 509 <!-- TYPE --> 510 <div style="display:inline"> 511 ( 512 <span class="optional" style="display: none; ">optional</span> 513 <span class="enum" style="display: none; ">enumerated</span> 514 <span id="typeTemplate"> 515 <span style="display: none; "> 516 <a> Type</a> 517 </span> 518 <span> 519 <span style="display: none; "> 520 array of <span><span></span></span> 521 </span> 522 <span>integer</span> 523 <span style="display: none; "></span> 524 </span> 525 </span> 526 ) 527 </div> 528 529 </em> 530 </dt> 531 <dd class="todo" style="display: none; "> 532 Undocumented. 533 </dd> 534 <dd>The id of the tab for which you want to modify the page action.</dd> 535 <dd style="display: none; "> 536 This parameter was added in version 537 <b><span></span></b>. 538 You must omit this parameter in earlier versions, 539 and you may omit it in any version. If you require this 540 parameter, the manifest key 541 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 542 can ensure that your extension won't be run in an earlier browser version. 543 </dd> 544 545 <!-- OBJECT PROPERTIES --> 546 <dd style="display: none; "> 547 <dl> 548 <div> 549 <div> 550 </div> 551 </div> 552 </dl> 553 </dd> 554 555 <!-- OBJECT METHODS --> 556 <dd style="display: none; "> 557 <div></div> 558 </dd> 559 560 <!-- OBJECT EVENT FIELDS --> 561 <dd style="display: none; "> 562 <div></div> 563 </dd> 564 565 <!-- FUNCTION PARAMETERS --> 566 <dd style="display: none; "> 567 <div></div> 568 </dd> 569 570 </div> 571 </div> 572 </dl> 573 574 <!-- RETURNS --> 575 <h4 style="display: none; ">Returns</h4> 576 <dl> 577 <div style="display: none; "> 578 <div> 579 </div> 580 </div> 581 </dl> 582 583 <!-- CALLBACK --> 584 <div style="display: none; "> 585 <div> 586 <h4>Callback function</h4> 587 <p> 588 The callback <em>parameter</em> should specify a function 589 that looks like this: 590 </p> 591 <p> 592 If you specify the <em>callback</em> parameter, it should 593 specify a function that looks like this: 594 </p> 595 596 <!-- Note: intentionally longer 80 columns --> 597 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 598 <dl> 599 <div> 600 <div> 601 </div> 602 </div> 603 </dl> 604 </div> 605 </div> 606 607 <!-- MIN_VERSION --> 608 <p style="display: none; "> 609 This function was added in version <b><span></span></b>. 610 If you require this function, the manifest key 611 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 612 can ensure that your extension won't be run in an earlier browser version. 613 </p> 614 </div> <!-- /description --> 615 616 </div><div class="apiItem"> 617 <a name="method-setIcon"></a> <!-- method-anchor --> 618 <h4>setIcon</h4> 619 620 <div class="summary"><span style="display: none; ">void</span> 621 <!-- Note: intentionally longer 80 columns --> 622 <span>chrome.pageAction.setIcon</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 623 <var><span>details</span></var></span>)</div> 624 625 <div class="description"> 626 <p class="todo" style="display: none; ">Undocumented.</p> 627 <p>Sets the icon for the page action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element. Either the <b>path</b> or the <b>imageData</b> property must be specified.</p> 628 629 <!-- PARAMETERS --> 630 <h4>Parameters</h4> 631 <dl> 632 <div> 633 <div> 634 <dt> 635 <var>details</var> 636 <em> 637 638 <!-- TYPE --> 639 <div style="display:inline"> 640 ( 641 <span class="optional" style="display: none; ">optional</span> 642 <span class="enum" style="display: none; ">enumerated</span> 643 <span id="typeTemplate"> 644 <span style="display: none; "> 645 <a> Type</a> 646 </span> 647 <span> 648 <span style="display: none; "> 649 array of <span><span></span></span> 650 </span> 651 <span>object</span> 652 <span style="display: none; "></span> 653 </span> 654 </span> 655 ) 656 </div> 657 658 </em> 659 </dt> 660 <dd class="todo"> 661 Undocumented. 662 </dd> 663 <dd style="display: none; "> 664 Description of this parameter from the json schema. 665 </dd> 666 <dd style="display: none; "> 667 This parameter was added in version 668 <b><span></span></b>. 669 You must omit this parameter in earlier versions, 670 and you may omit it in any version. If you require this 671 parameter, the manifest key 672 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 673 can ensure that your extension won't be run in an earlier browser version. 674 </dd> 675 676 <!-- OBJECT PROPERTIES --> 677 <dd> 678 <dl> 679 <div> 680 <div> 681 <dt> 682 <var>tabId</var> 683 <em> 684 685 <!-- TYPE --> 686 <div style="display:inline"> 687 ( 688 <span class="optional" style="display: none; ">optional</span> 689 <span class="enum" style="display: none; ">enumerated</span> 690 <span id="typeTemplate"> 691 <span style="display: none; "> 692 <a> Type</a> 693 </span> 694 <span> 695 <span style="display: none; "> 696 array of <span><span></span></span> 697 </span> 698 <span>integer</span> 699 <span style="display: none; "></span> 700 </span> 701 </span> 702 ) 703 </div> 704 705 </em> 706 </dt> 707 <dd class="todo" style="display: none; "> 708 Undocumented. 709 </dd> 710 <dd>The id of the tab for which you want to modify the page action.</dd> 711 <dd style="display: none; "> 712 This parameter was added in version 713 <b><span></span></b>. 714 You must omit this parameter in earlier versions, 715 and you may omit it in any version. If you require this 716 parameter, the manifest key 717 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 718 can ensure that your extension won't be run in an earlier browser version. 719 </dd> 720 721 <!-- OBJECT PROPERTIES --> 722 <dd style="display: none; "> 723 <dl> 724 <div> 725 <div> 726 </div> 727 </div> 728 </dl> 729 </dd> 730 731 <!-- OBJECT METHODS --> 732 <dd style="display: none; "> 733 <div></div> 734 </dd> 735 736 <!-- OBJECT EVENT FIELDS --> 737 <dd style="display: none; "> 738 <div></div> 739 </dd> 740 741 <!-- FUNCTION PARAMETERS --> 742 <dd style="display: none; "> 743 <div></div> 744 </dd> 745 746 </div> 747 </div><div> 748 <div> 749 <dt> 750 <var>imageData</var> 751 <em> 752 753 <!-- TYPE --> 754 <div style="display:inline"> 755 ( 756 <span class="optional">optional</span> 757 <span class="enum" style="display: none; ">enumerated</span> 758 <span id="typeTemplate"> 759 <span style="display: none; "> 760 <a> Type</a> 761 </span> 762 <span> 763 <span style="display: none; "> 764 array of <span><span></span></span> 765 </span> 766 <span>ImageData</span> 767 <span style="display: none; "></span> 768 </span> 769 </span> 770 ) 771 </div> 772 773 </em> 774 </dt> 775 <dd class="todo" style="display: none; "> 776 Undocumented. 777 </dd> 778 <dd>Pixel data for an image. Must be an ImageData object (for example, from a canvas element).</dd> 779 <dd style="display: none; "> 780 This parameter was added in version 781 <b><span></span></b>. 782 You must omit this parameter in earlier versions, 783 and you may omit it in any version. If you require this 784 parameter, the manifest key 785 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 786 can ensure that your extension won't be run in an earlier browser version. 787 </dd> 788 789 <!-- OBJECT PROPERTIES --> 790 <dd> 791 <dl> 792 <div style="display: none; "> 793 <div> 794 </div> 795 </div> 796 </dl> 797 </dd> 798 799 <!-- OBJECT METHODS --> 800 <dd style="display: none; "> 801 <div></div> 802 </dd> 803 804 <!-- OBJECT EVENT FIELDS --> 805 <dd style="display: none; "> 806 <div></div> 807 </dd> 808 809 <!-- FUNCTION PARAMETERS --> 810 <dd style="display: none; "> 811 <div></div> 812 </dd> 813 814 </div> 815 </div><div> 816 <div> 817 <dt> 818 <var>path</var> 819 <em> 820 821 <!-- TYPE --> 822 <div style="display:inline"> 823 ( 824 <span class="optional">optional</span> 825 <span class="enum" style="display: none; ">enumerated</span> 826 <span id="typeTemplate"> 827 <span style="display: none; "> 828 <a> Type</a> 829 </span> 830 <span> 831 <span style="display: none; "> 832 array of <span><span></span></span> 833 </span> 834 <span>string</span> 835 <span style="display: none; "></span> 836 </span> 837 </span> 838 ) 839 </div> 840 841 </em> 842 </dt> 843 <dd class="todo" style="display: none; "> 844 Undocumented. 845 </dd> 846 <dd>Relative path to an image in the extension to show in the browser action.</dd> 847 <dd style="display: none; "> 848 This parameter was added in version 849 <b><span></span></b>. 850 You must omit this parameter in earlier versions, 851 and you may omit it in any version. If you require this 852 parameter, the manifest key 853 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 854 can ensure that your extension won't be run in an earlier browser version. 855 </dd> 856 857 <!-- OBJECT PROPERTIES --> 858 <dd style="display: none; "> 859 <dl> 860 <div> 861 <div> 862 </div> 863 </div> 864 </dl> 865 </dd> 866 867 <!-- OBJECT METHODS --> 868 <dd style="display: none; "> 869 <div></div> 870 </dd> 871 872 <!-- OBJECT EVENT FIELDS --> 873 <dd style="display: none; "> 874 <div></div> 875 </dd> 876 877 <!-- FUNCTION PARAMETERS --> 878 <dd style="display: none; "> 879 <div></div> 880 </dd> 881 882 </div> 883 </div><div> 884 <div> 885 <dt> 886 <var>iconIndex</var> 887 <em> 888 889 <!-- TYPE --> 890 <div style="display:inline"> 891 ( 892 <span class="optional">optional</span> 893 <span class="enum" style="display: none; ">enumerated</span> 894 <span id="typeTemplate"> 895 <span style="display: none; "> 896 <a> Type</a> 897 </span> 898 <span> 899 <span style="display: none; "> 900 array of <span><span></span></span> 901 </span> 902 <span>integer</span> 903 <span style="display: none; "></span> 904 </span> 905 </span> 906 ) 907 </div> 908 909 </em> 910 </dt> 911 <dd class="todo" style="display: none; "> 912 Undocumented. 913 </dd> 914 <dd><b>Deprecated.</b> The zero-based index into the <b>icons</b> vector specified in the manifest.</dd> 915 <dd style="display: none; "> 916 This parameter was added in version 917 <b><span></span></b>. 918 You must omit this parameter in earlier versions, 919 and you may omit it in any version. If you require this 920 parameter, the manifest key 921 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 922 can ensure that your extension won't be run in an earlier browser version. 923 </dd> 924 925 <!-- OBJECT PROPERTIES --> 926 <dd style="display: none; "> 927 <dl> 928 <div> 929 <div> 930 </div> 931 </div> 932 </dl> 933 </dd> 934 935 <!-- OBJECT METHODS --> 936 <dd style="display: none; "> 937 <div></div> 938 </dd> 939 940 <!-- OBJECT EVENT FIELDS --> 941 <dd style="display: none; "> 942 <div></div> 943 </dd> 944 945 <!-- FUNCTION PARAMETERS --> 946 <dd style="display: none; "> 947 <div></div> 948 </dd> 949 950 </div> 951 </div> 952 </dl> 953 </dd> 954 955 <!-- OBJECT METHODS --> 956 <dd style="display: none; "> 957 <div></div> 958 </dd> 959 960 <!-- OBJECT EVENT FIELDS --> 961 <dd style="display: none; "> 962 <div></div> 963 </dd> 964 965 <!-- FUNCTION PARAMETERS --> 966 <dd style="display: none; "> 967 <div></div> 968 </dd> 969 970 </div> 971 </div> 972 </dl> 973 974 <!-- RETURNS --> 975 <h4 style="display: none; ">Returns</h4> 976 <dl> 977 <div style="display: none; "> 978 <div> 979 </div> 980 </div> 981 </dl> 982 983 <!-- CALLBACK --> 984 <div style="display: none; "> 985 <div> 986 <h4>Callback function</h4> 987 <p> 988 The callback <em>parameter</em> should specify a function 989 that looks like this: 990 </p> 991 <p> 992 If you specify the <em>callback</em> parameter, it should 993 specify a function that looks like this: 994 </p> 995 996 <!-- Note: intentionally longer 80 columns --> 997 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 998 <dl> 999 <div> 1000 <div> 1001 </div> 1002 </div> 1003 </dl> 1004 </div> 1005 </div> 1006 1007 <!-- MIN_VERSION --> 1008 <p style="display: none; "> 1009 This function was added in version <b><span></span></b>. 1010 If you require this function, the manifest key 1011 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1012 can ensure that your extension won't be run in an earlier browser version. 1013 </p> 1014 </div> <!-- /description --> 1015 1016 </div><div class="apiItem"> 1017 <a name="method-setPopup"></a> <!-- method-anchor --> 1018 <h4>setPopup</h4> 1019 1020 <div class="summary"><span style="display: none; ">void</span> 1021 <!-- Note: intentionally longer 80 columns --> 1022 <span>chrome.pageAction.setPopup</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1023 <var><span>details</span></var></span>)</div> 1024 1025 <div class="description"> 1026 <p class="todo" style="display: none; ">Undocumented.</p> 1027 <p>Sets the html document to be opened as a popup when the user clicks on the page action's icon.</p> 1028 1029 <!-- PARAMETERS --> 1030 <h4>Parameters</h4> 1031 <dl> 1032 <div> 1033 <div> 1034 <dt> 1035 <var>details</var> 1036 <em> 1037 1038 <!-- TYPE --> 1039 <div style="display:inline"> 1040 ( 1041 <span class="optional" style="display: none; ">optional</span> 1042 <span class="enum" style="display: none; ">enumerated</span> 1043 <span id="typeTemplate"> 1044 <span style="display: none; "> 1045 <a> Type</a> 1046 </span> 1047 <span> 1048 <span style="display: none; "> 1049 array of <span><span></span></span> 1050 </span> 1051 <span>object</span> 1052 <span style="display: none; "></span> 1053 </span> 1054 </span> 1055 ) 1056 </div> 1057 1058 </em> 1059 </dt> 1060 <dd class="todo"> 1061 Undocumented. 1062 </dd> 1063 <dd style="display: none; "> 1064 Description of this parameter from the json schema. 1065 </dd> 1066 <dd style="display: none; "> 1067 This parameter was added in version 1068 <b><span></span></b>. 1069 You must omit this parameter in earlier versions, 1070 and you may omit it in any version. If you require this 1071 parameter, the manifest key 1072 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1073 can ensure that your extension won't be run in an earlier browser version. 1074 </dd> 1075 1076 <!-- OBJECT PROPERTIES --> 1077 <dd> 1078 <dl> 1079 <div> 1080 <div> 1081 <dt> 1082 <var>tabId</var> 1083 <em> 1084 1085 <!-- TYPE --> 1086 <div style="display:inline"> 1087 ( 1088 <span class="optional" style="display: none; ">optional</span> 1089 <span class="enum" style="display: none; ">enumerated</span> 1090 <span id="typeTemplate"> 1091 <span style="display: none; "> 1092 <a> Type</a> 1093 </span> 1094 <span> 1095 <span style="display: none; "> 1096 array of <span><span></span></span> 1097 </span> 1098 <span>integer</span> 1099 <span style="display: none; "></span> 1100 </span> 1101 </span> 1102 ) 1103 </div> 1104 1105 </em> 1106 </dt> 1107 <dd class="todo" style="display: none; "> 1108 Undocumented. 1109 </dd> 1110 <dd>The id of the tab for which you want to modify the page action.</dd> 1111 <dd style="display: none; "> 1112 This parameter was added in version 1113 <b><span></span></b>. 1114 You must omit this parameter in earlier versions, 1115 and you may omit it in any version. If you require this 1116 parameter, the manifest key 1117 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1118 can ensure that your extension won't be run in an earlier browser version. 1119 </dd> 1120 1121 <!-- OBJECT PROPERTIES --> 1122 <dd style="display: none; "> 1123 <dl> 1124 <div> 1125 <div> 1126 </div> 1127 </div> 1128 </dl> 1129 </dd> 1130 1131 <!-- OBJECT METHODS --> 1132 <dd style="display: none; "> 1133 <div></div> 1134 </dd> 1135 1136 <!-- OBJECT EVENT FIELDS --> 1137 <dd style="display: none; "> 1138 <div></div> 1139 </dd> 1140 1141 <!-- FUNCTION PARAMETERS --> 1142 <dd style="display: none; "> 1143 <div></div> 1144 </dd> 1145 1146 </div> 1147 </div><div> 1148 <div> 1149 <dt> 1150 <var>popup</var> 1151 <em> 1152 1153 <!-- TYPE --> 1154 <div style="display:inline"> 1155 ( 1156 <span class="optional" style="display: none; ">optional</span> 1157 <span class="enum" style="display: none; ">enumerated</span> 1158 <span id="typeTemplate"> 1159 <span style="display: none; "> 1160 <a> Type</a> 1161 </span> 1162 <span> 1163 <span style="display: none; "> 1164 array of <span><span></span></span> 1165 </span> 1166 <span>string</span> 1167 <span style="display: none; "></span> 1168 </span> 1169 </span> 1170 ) 1171 </div> 1172 1173 </em> 1174 </dt> 1175 <dd class="todo" style="display: none; "> 1176 Undocumented. 1177 </dd> 1178 <dd>The html file to show in a popup. If set to the empty string (''), no popup is shown.</dd> 1179 <dd style="display: none; "> 1180 This parameter was added in version 1181 <b><span></span></b>. 1182 You must omit this parameter in earlier versions, 1183 and you may omit it in any version. If you require this 1184 parameter, the manifest key 1185 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1186 can ensure that your extension won't be run in an earlier browser version. 1187 </dd> 1188 1189 <!-- OBJECT PROPERTIES --> 1190 <dd style="display: none; "> 1191 <dl> 1192 <div> 1193 <div> 1194 </div> 1195 </div> 1196 </dl> 1197 </dd> 1198 1199 <!-- OBJECT METHODS --> 1200 <dd style="display: none; "> 1201 <div></div> 1202 </dd> 1203 1204 <!-- OBJECT EVENT FIELDS --> 1205 <dd style="display: none; "> 1206 <div></div> 1207 </dd> 1208 1209 <!-- FUNCTION PARAMETERS --> 1210 <dd style="display: none; "> 1211 <div></div> 1212 </dd> 1213 1214 </div> 1215 </div> 1216 </dl> 1217 </dd> 1218 1219 <!-- OBJECT METHODS --> 1220 <dd style="display: none; "> 1221 <div></div> 1222 </dd> 1223 1224 <!-- OBJECT EVENT FIELDS --> 1225 <dd style="display: none; "> 1226 <div></div> 1227 </dd> 1228 1229 <!-- FUNCTION PARAMETERS --> 1230 <dd style="display: none; "> 1231 <div></div> 1232 </dd> 1233 1234 </div> 1235 </div> 1236 </dl> 1237 1238 <!-- RETURNS --> 1239 <h4 style="display: none; ">Returns</h4> 1240 <dl> 1241 <div style="display: none; "> 1242 <div> 1243 </div> 1244 </div> 1245 </dl> 1246 1247 <!-- CALLBACK --> 1248 <div style="display: none; "> 1249 <div> 1250 <h4>Callback function</h4> 1251 <p> 1252 The callback <em>parameter</em> should specify a function 1253 that looks like this: 1254 </p> 1255 <p> 1256 If you specify the <em>callback</em> parameter, it should 1257 specify a function that looks like this: 1258 </p> 1259 1260 <!-- Note: intentionally longer 80 columns --> 1261 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1262 <dl> 1263 <div> 1264 <div> 1265 </div> 1266 </div> 1267 </dl> 1268 </div> 1269 </div> 1270 1271 <!-- MIN_VERSION --> 1272 <p> 1273 This function was added in version <b><span>5.0.308.0</span></b>. 1274 If you require this function, the manifest key 1275 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1276 can ensure that your extension won't be run in an earlier browser version. 1277 </p> 1278 </div> <!-- /description --> 1279 1280 </div><div class="apiItem"> 1281 <a name="method-setTitle"></a> <!-- method-anchor --> 1282 <h4>setTitle</h4> 1283 1284 <div class="summary"><span style="display: none; ">void</span> 1285 <!-- Note: intentionally longer 80 columns --> 1286 <span>chrome.pageAction.setTitle</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1287 <var><span>details</span></var></span>)</div> 1288 1289 <div class="description"> 1290 <p class="todo" style="display: none; ">Undocumented.</p> 1291 <p>Sets the title of the page action. This is displayed in a tooltip over the page action.</p> 1292 1293 <!-- PARAMETERS --> 1294 <h4>Parameters</h4> 1295 <dl> 1296 <div> 1297 <div> 1298 <dt> 1299 <var>details</var> 1300 <em> 1301 1302 <!-- TYPE --> 1303 <div style="display:inline"> 1304 ( 1305 <span class="optional" style="display: none; ">optional</span> 1306 <span class="enum" style="display: none; ">enumerated</span> 1307 <span id="typeTemplate"> 1308 <span style="display: none; "> 1309 <a> Type</a> 1310 </span> 1311 <span> 1312 <span style="display: none; "> 1313 array of <span><span></span></span> 1314 </span> 1315 <span>object</span> 1316 <span style="display: none; "></span> 1317 </span> 1318 </span> 1319 ) 1320 </div> 1321 1322 </em> 1323 </dt> 1324 <dd class="todo"> 1325 Undocumented. 1326 </dd> 1327 <dd style="display: none; "> 1328 Description of this parameter from the json schema. 1329 </dd> 1330 <dd style="display: none; "> 1331 This parameter was added in version 1332 <b><span></span></b>. 1333 You must omit this parameter in earlier versions, 1334 and you may omit it in any version. If you require this 1335 parameter, the manifest key 1336 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1337 can ensure that your extension won't be run in an earlier browser version. 1338 </dd> 1339 1340 <!-- OBJECT PROPERTIES --> 1341 <dd> 1342 <dl> 1343 <div> 1344 <div> 1345 <dt> 1346 <var>tabId</var> 1347 <em> 1348 1349 <!-- TYPE --> 1350 <div style="display:inline"> 1351 ( 1352 <span class="optional" style="display: none; ">optional</span> 1353 <span class="enum" style="display: none; ">enumerated</span> 1354 <span id="typeTemplate"> 1355 <span style="display: none; "> 1356 <a> Type</a> 1357 </span> 1358 <span> 1359 <span style="display: none; "> 1360 array of <span><span></span></span> 1361 </span> 1362 <span>integer</span> 1363 <span style="display: none; "></span> 1364 </span> 1365 </span> 1366 ) 1367 </div> 1368 1369 </em> 1370 </dt> 1371 <dd class="todo" style="display: none; "> 1372 Undocumented. 1373 </dd> 1374 <dd>The id of the tab for which you want to modify the page action.</dd> 1375 <dd style="display: none; "> 1376 This parameter was added in version 1377 <b><span></span></b>. 1378 You must omit this parameter in earlier versions, 1379 and you may omit it in any version. If you require this 1380 parameter, the manifest key 1381 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1382 can ensure that your extension won't be run in an earlier browser version. 1383 </dd> 1384 1385 <!-- OBJECT PROPERTIES --> 1386 <dd style="display: none; "> 1387 <dl> 1388 <div> 1389 <div> 1390 </div> 1391 </div> 1392 </dl> 1393 </dd> 1394 1395 <!-- OBJECT METHODS --> 1396 <dd style="display: none; "> 1397 <div></div> 1398 </dd> 1399 1400 <!-- OBJECT EVENT FIELDS --> 1401 <dd style="display: none; "> 1402 <div></div> 1403 </dd> 1404 1405 <!-- FUNCTION PARAMETERS --> 1406 <dd style="display: none; "> 1407 <div></div> 1408 </dd> 1409 1410 </div> 1411 </div><div> 1412 <div> 1413 <dt> 1414 <var>title</var> 1415 <em> 1416 1417 <!-- TYPE --> 1418 <div style="display:inline"> 1419 ( 1420 <span class="optional" style="display: none; ">optional</span> 1421 <span class="enum" style="display: none; ">enumerated</span> 1422 <span id="typeTemplate"> 1423 <span style="display: none; "> 1424 <a> Type</a> 1425 </span> 1426 <span> 1427 <span style="display: none; "> 1428 array of <span><span></span></span> 1429 </span> 1430 <span>string</span> 1431 <span style="display: none; "></span> 1432 </span> 1433 </span> 1434 ) 1435 </div> 1436 1437 </em> 1438 </dt> 1439 <dd class="todo" style="display: none; "> 1440 Undocumented. 1441 </dd> 1442 <dd>The tooltip string.</dd> 1443 <dd style="display: none; "> 1444 This parameter was added in version 1445 <b><span></span></b>. 1446 You must omit this parameter in earlier versions, 1447 and you may omit it in any version. If you require this 1448 parameter, the manifest key 1449 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1450 can ensure that your extension won't be run in an earlier browser version. 1451 </dd> 1452 1453 <!-- OBJECT PROPERTIES --> 1454 <dd style="display: none; "> 1455 <dl> 1456 <div> 1457 <div> 1458 </div> 1459 </div> 1460 </dl> 1461 </dd> 1462 1463 <!-- OBJECT METHODS --> 1464 <dd style="display: none; "> 1465 <div></div> 1466 </dd> 1467 1468 <!-- OBJECT EVENT FIELDS --> 1469 <dd style="display: none; "> 1470 <div></div> 1471 </dd> 1472 1473 <!-- FUNCTION PARAMETERS --> 1474 <dd style="display: none; "> 1475 <div></div> 1476 </dd> 1477 1478 </div> 1479 </div> 1480 </dl> 1481 </dd> 1482 1483 <!-- OBJECT METHODS --> 1484 <dd style="display: none; "> 1485 <div></div> 1486 </dd> 1487 1488 <!-- OBJECT EVENT FIELDS --> 1489 <dd style="display: none; "> 1490 <div></div> 1491 </dd> 1492 1493 <!-- FUNCTION PARAMETERS --> 1494 <dd style="display: none; "> 1495 <div></div> 1496 </dd> 1497 1498 </div> 1499 </div> 1500 </dl> 1501 1502 <!-- RETURNS --> 1503 <h4 style="display: none; ">Returns</h4> 1504 <dl> 1505 <div style="display: none; "> 1506 <div> 1507 </div> 1508 </div> 1509 </dl> 1510 1511 <!-- CALLBACK --> 1512 <div style="display: none; "> 1513 <div> 1514 <h4>Callback function</h4> 1515 <p> 1516 The callback <em>parameter</em> should specify a function 1517 that looks like this: 1518 </p> 1519 <p> 1520 If you specify the <em>callback</em> parameter, it should 1521 specify a function that looks like this: 1522 </p> 1523 1524 <!-- Note: intentionally longer 80 columns --> 1525 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1526 <dl> 1527 <div> 1528 <div> 1529 </div> 1530 </div> 1531 </dl> 1532 </div> 1533 </div> 1534 1535 <!-- MIN_VERSION --> 1536 <p style="display: none; "> 1537 This function was added in version <b><span></span></b>. 1538 If you require this function, the manifest key 1539 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1540 can ensure that your extension won't be run in an earlier browser version. 1541 </p> 1542 </div> <!-- /description --> 1543 1544 </div><div class="apiItem"> 1545 <a name="method-show"></a> <!-- method-anchor --> 1546 <h4>show</h4> 1547 1548 <div class="summary"><span style="display: none; ">void</span> 1549 <!-- Note: intentionally longer 80 columns --> 1550 <span>chrome.pageAction.show</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 1551 <var><span>tabId</span></var></span>)</div> 1552 1553 <div class="description"> 1554 <p class="todo" style="display: none; ">Undocumented.</p> 1555 <p>Shows the page action. The page action is shown whenever the tab is selected.</p> 1556 1557 <!-- PARAMETERS --> 1558 <h4>Parameters</h4> 1559 <dl> 1560 <div> 1561 <div> 1562 <dt> 1563 <var>tabId</var> 1564 <em> 1565 1566 <!-- TYPE --> 1567 <div style="display:inline"> 1568 ( 1569 <span class="optional" style="display: none; ">optional</span> 1570 <span class="enum" style="display: none; ">enumerated</span> 1571 <span id="typeTemplate"> 1572 <span style="display: none; "> 1573 <a> Type</a> 1574 </span> 1575 <span> 1576 <span style="display: none; "> 1577 array of <span><span></span></span> 1578 </span> 1579 <span>integer</span> 1580 <span style="display: none; "></span> 1581 </span> 1582 </span> 1583 ) 1584 </div> 1585 1586 </em> 1587 </dt> 1588 <dd class="todo" style="display: none; "> 1589 Undocumented. 1590 </dd> 1591 <dd>The id of the tab for which you want to modify the page action.</dd> 1592 <dd style="display: none; "> 1593 This parameter was added in version 1594 <b><span></span></b>. 1595 You must omit this parameter in earlier versions, 1596 and you may omit it in any version. If you require this 1597 parameter, the manifest key 1598 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1599 can ensure that your extension won't be run in an earlier browser version. 1600 </dd> 1601 1602 <!-- OBJECT PROPERTIES --> 1603 <dd style="display: none; "> 1604 <dl> 1605 <div> 1606 <div> 1607 </div> 1608 </div> 1609 </dl> 1610 </dd> 1611 1612 <!-- OBJECT METHODS --> 1613 <dd style="display: none; "> 1614 <div></div> 1615 </dd> 1616 1617 <!-- OBJECT EVENT FIELDS --> 1618 <dd style="display: none; "> 1619 <div></div> 1620 </dd> 1621 1622 <!-- FUNCTION PARAMETERS --> 1623 <dd style="display: none; "> 1624 <div></div> 1625 </dd> 1626 1627 </div> 1628 </div> 1629 </dl> 1630 1631 <!-- RETURNS --> 1632 <h4 style="display: none; ">Returns</h4> 1633 <dl> 1634 <div style="display: none; "> 1635 <div> 1636 </div> 1637 </div> 1638 </dl> 1639 1640 <!-- CALLBACK --> 1641 <div style="display: none; "> 1642 <div> 1643 <h4>Callback function</h4> 1644 <p> 1645 The callback <em>parameter</em> should specify a function 1646 that looks like this: 1647 </p> 1648 <p> 1649 If you specify the <em>callback</em> parameter, it should 1650 specify a function that looks like this: 1651 </p> 1652 1653 <!-- Note: intentionally longer 80 columns --> 1654 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1655 <dl> 1656 <div> 1657 <div> 1658 </div> 1659 </div> 1660 </dl> 1661 </div> 1662 </div> 1663 1664 <!-- MIN_VERSION --> 1665 <p style="display: none; "> 1666 This function was added in version <b><span></span></b>. 1667 If you require this function, the manifest key 1668 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1669 can ensure that your extension won't be run in an earlier browser version. 1670 </p> 1671 </div> <!-- /description --> 1672 1673 </div> <!-- /apiItem --> 1674 1675 </div> <!-- /apiGroup --> 1676 1677 <!-- EVENTS --> 1678 <div id="eventsTemplate" class="apiGroup"> 1679 <a name="global-events"></a> 1680 <h3>Events</h3> 1681 <!-- iterates over all events --> 1682 <div class="apiItem"> 1683 <a name="event-onClicked"></a> 1684 <h4>onClicked</h4> 1685 1686 <div class="summary"> 1687 <!-- Note: intentionally longer 80 columns --> 1688 <span class="subdued">chrome.pageAction.</span><span>onClicked</span><span class="subdued">.addListener</span>(function(<span>Tab tab</span>) <span class="subdued">{...}</span>); 1689 </div> 1690 1691 <div class="description"> 1692 <p class="todo" style="display: none; ">Undocumented.</p> 1693 <p>Fired when a page action icon is clicked. This event will not fire if the page action has a popup.</p> 1694 1695 <!-- PARAMETERS --> 1696 <div> 1697 <h4>Parameters</h4> 1698 <dl> 1699 <div> 1700 <div> 1701 <dt> 1702 <var>tab</var> 1703 <em> 1704 1705 <!-- TYPE --> 1706 <div style="display:inline"> 1707 ( 1708 <span class="optional" style="display: none; ">optional</span> 1709 <span class="enum" style="display: none; ">enumerated</span> 1710 <span id="typeTemplate"> 1711 <span> 1712 <a href="tabs.html#type-Tab">Tab</a> 1713 </span> 1714 <span style="display: none; "> 1715 <span> 1716 array of <span><span></span></span> 1717 </span> 1718 <span>paramType</span> 1719 <span></span> 1720 </span> 1721 </span> 1722 ) 1723 </div> 1724 1725 </em> 1726 </dt> 1727 <dd class="todo"> 1728 Undocumented. 1729 </dd> 1730 <dd style="display: none; "> 1731 Description of this parameter from the json schema. 1732 </dd> 1733 <dd style="display: none; "> 1734 This parameter was added in version 1735 <b><span></span></b>. 1736 You must omit this parameter in earlier versions, 1737 and you may omit it in any version. If you require this 1738 parameter, the manifest key 1739 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1740 can ensure that your extension won't be run in an earlier browser version. 1741 </dd> 1742 1743 <!-- OBJECT PROPERTIES --> 1744 <dd style="display: none; "> 1745 <dl> 1746 <div> 1747 <div> 1748 </div> 1749 </div> 1750 </dl> 1751 </dd> 1752 1753 <!-- OBJECT METHODS --> 1754 <dd style="display: none; "> 1755 <div></div> 1756 </dd> 1757 1758 <!-- OBJECT EVENT FIELDS --> 1759 <dd style="display: none; "> 1760 <div></div> 1761 </dd> 1762 1763 <!-- FUNCTION PARAMETERS --> 1764 <dd style="display: none; "> 1765 <div></div> 1766 </dd> 1767 1768 </div> 1769 </div> 1770 </dl> 1771 </div> 1772 </div> <!-- /decription --> 1773 1774 </div> <!-- /apiItem --> 1775 1776 </div> <!-- /apiGroup --> 1777 1778 <!-- TYPES --> 1779 <div class="apiGroup" style="display: none; "> 1780 <a name="types"></a> 1781 <h3 id="types">Types</h3> 1782 1783 <!-- iterates over all types --> 1784 <div class="apiItem"> 1785 <a></a> 1786 <h4>type name</h4> 1787 1788 <div> 1789 </div> 1790 1791 </div> <!-- /apiItem --> 1792 1793 </div> <!-- /apiGroup --> 1794 1795 </div> <!-- /apiPage --> 1796 </div> <!-- /gc-pagecontent --> 1797 </div> <!-- /g-section --> 1798 </div> <!-- /codesiteContent --> 1799 <div id="gc-footer" --=""> 1800 <div class="text"> 1801 <p> 1802 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 1803 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 1804 Attribution 3.0 License</a>, and code samples are licensed under the 1805 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 1806 </p> 1807 <p> 1808 2011 Google 1809 </p> 1810 1811 <!-- begin analytics --> 1812 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 1813 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 1814 1815 <script type="text/javascript"> 1816 // chrome doc tracking 1817 try { 1818 var engdocs = _gat._getTracker("YT-10763712-2"); 1819 engdocs._trackPageview(); 1820 } catch(err) {} 1821 1822 // code.google.com site-wide tracking 1823 try { 1824 _uacct="UA-18071-1"; 1825 _uanchor=1; 1826 _uff=0; 1827 urchinTracker(); 1828 } 1829 catch(e) {/* urchinTracker not available. */} 1830 </script> 1831 <!-- end analytics --> 1832 </div> 1833 </div> <!-- /gc-footer --> 1834 </div> <!-- /gc-container --> 1835 </body></html> 1836
