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

Side by Side Diff: chrome/common/extensions/docs/experimental.offscreenTabs.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
(Empty)
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/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <meta name="description" content="Documentation for the chrome.experimental.of fscreenTabs module, which is part of the Google Chrome extension APIs."><title> chrome.experimental.offscreenTabs - Google Chrome Extensions - Google Code</titl e></head>
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li>
122 <li><a href="cookies.html">Cookies</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">chrome.experimental.offscreenTabs</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#apiReference">API reference: chrome.experimental.offsc reenTabs</a>
196 <ol>
197 <li>
198 <a href="#global-methods">Methods</a>
199 <ol>
200 <li>
201 <a href="#method-create">create</a>
202 </li><li>
203 <a href="#method-get">get</a>
204 </li><li>
205 <a href="#method-getAll">getAll</a>
206 </li><li>
207 <a href="#method-remove">remove</a>
208 </li><li>
209 <a href="#method-sendKeyboardEvent">sendKeyboardEvent</a>
210 </li><li>
211 <a href="#method-sendMouseEvent">sendMouseEvent</a>
212 </li><li>
213 <a href="#method-toDataUrl">toDataUrl</a>
214 </li><li>
215 <a href="#method-update">update</a>
216 </li>
217 </ol>
218 </li>
219 <li>
220 <a href="#global-events">Events</a>
221 <ol>
222 <li>
223 <a href="#event-onUpdated">onUpdated</a>
224 </li>
225 </ol>
226 </li>
227 <li>
228 <a href="#types">Types</a>
229 <ol>
230 <li>
231 <a href="#type-OffscreenTab">OffscreenTab</a>
232 <ol>
233 </ol>
234 </li><li>
235 <a href="#type-MouseEvent">MouseEvent</a>
236 <ol>
237 </ol>
238 </li><li>
239 <a href="#type-KeyboardEvent">KeyboardEvent</a>
240 <ol>
241 </ol>
242 </li>
243 </ol>
244 </li>
245 </ol>
246 </li>
247 </ol>
248 </div>
249 <!-- /TABLE OF CONTENTS -->
250 <!-- Standard content lead-in for experimental API pages -->
251 <p id="classSummary">
252 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
253 </p>
254 <!-- STATIC CONTENT PLACEHOLDER -->
255 <div id="static"></div>
256 <!-- API PAGE -->
257 <div class="apiPage">
258 <a name="apiReference"></a>
259 <h2>API reference: chrome.experimental.offscreenTabs</h2>
260 <!-- PROPERTIES -->
261 <!-- /apiGroup -->
262 <!-- METHODS -->
263 <div id="methodsTemplate" class="apiGroup">
264 <a name="global-methods"></a>
265 <h3>Methods</h3>
266 <!-- iterates over all functions -->
267 <div class="apiItem">
268 <a name="method-create"></a> <!-- method-anchor -->
269 <h4>create</h4>
270 <div class="summary">
271 <!-- Note: intentionally longer 80 columns -->
272 <span>chrome.experimental.offscreenTabs.create</span>(<span cl ass="null"><span>object</span>
273 <var><span>createProperties</span></var></span><span class ="optional"><span>, </span><span>function</span>
274 <var><span>callback</span></var></span>)</div>
275 <div class="description">
276 <p>Creates a new offscreen tab.</p>
277 <!-- PARAMETERS -->
278 <h4>Parameters</h4>
279 <dl>
280 <div>
281 <div>
282 <dt>
283 <var>createProperties</var>
284 <em>
285 <!-- TYPE -->
286 <div style="display:inline">
287 (
288 <span id="typeTemplate">
289 <span>
290 <span>object</span>
291 </span>
292 </span>
293 )
294 </div>
295 </em>
296 </dt>
297 <dd class="todo">
298 Undocumented.
299 </dd>
300 <!-- OBJECT PROPERTIES -->
301 <dd>
302 <dl>
303 <div>
304 <div>
305 <dt>
306 <var>url</var>
307 <em>
308 <!-- TYPE -->
309 <div style="display:inline">
310 (
311 <span id="typeTemplate">
312 <span>
313 <span>string</span>
314 </span>
315 </span>
316 )
317 </div>
318 </em>
319 </dt>
320 <dd>The URL to navigate the offscreen tab to initially. Fully-qualifie d URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com' ). Relative URLs will be relative to the current page within the extension. Note that you can't create offscreen tabs from background pages. The lifetime of the offscreen tab is tied to the context of its creator (tab, browser action, etc.) .</dd>
321 <!-- OBJECT PROPERTIES -->
322 <!-- OBJECT METHODS -->
323 <!-- OBJECT EVENT FIELDS -->
324 <!-- FUNCTION PARAMETERS -->
325 </div>
326 </div><div>
327 <div>
328 <dt>
329 <var>width</var>
330 <em>
331 <!-- TYPE -->
332 <div style="display:inline">
333 (
334 <span class="optional">optional</span>
335 <span id="typeTemplate">
336 <span>
337 <span>integer</span>
338 </span>
339 </span>
340 )
341 </div>
342 </em>
343 </dt>
344 <dd>Width of the offscreen tab. Defaults to width of the current tab.< /dd>
345 <!-- OBJECT PROPERTIES -->
346 <!-- OBJECT METHODS -->
347 <!-- OBJECT EVENT FIELDS -->
348 <!-- FUNCTION PARAMETERS -->
349 </div>
350 </div><div>
351 <div>
352 <dt>
353 <var>height</var>
354 <em>
355 <!-- TYPE -->
356 <div style="display:inline">
357 (
358 <span class="optional">optional</span>
359 <span id="typeTemplate">
360 <span>
361 <span>integer</span>
362 </span>
363 </span>
364 )
365 </div>
366 </em>
367 </dt>
368 <dd>Height of the offscreen tab. Defaults to height of the current tab .</dd>
369 <!-- OBJECT PROPERTIES -->
370 <!-- OBJECT METHODS -->
371 <!-- OBJECT EVENT FIELDS -->
372 <!-- FUNCTION PARAMETERS -->
373 </div>
374 </div>
375 </dl>
376 </dd>
377 <!-- OBJECT METHODS -->
378 <!-- OBJECT EVENT FIELDS -->
379 <!-- FUNCTION PARAMETERS -->
380 </div>
381 </div><div>
382 <div>
383 <dt>
384 <var>callback</var>
385 <em>
386 <!-- TYPE -->
387 <div style="display:inline">
388 (
389 <span class="optional">optional</span>
390 <span id="typeTemplate">
391 <span>
392 <span>function</span>
393 </span>
394 </span>
395 )
396 </div>
397 </em>
398 </dt>
399 <dd class="todo">
400 Undocumented.
401 </dd>
402 <!-- OBJECT PROPERTIES -->
403 <!-- OBJECT METHODS -->
404 <!-- OBJECT EVENT FIELDS -->
405 <!-- FUNCTION PARAMETERS -->
406 </div>
407 </div>
408 </dl>
409 <!-- RETURNS -->
410 <dl>
411 </dl>
412 <!-- CALLBACK -->
413 <div>
414 <div>
415 <h4>Callback function</h4>
416 <p>
417 If you specify the <em>callback</em> parameter, it should
418 specify a function that looks like this:
419 </p>
420 <!-- Note: intentionally longer 80 columns -->
421 <pre>function(<span>OffscreenTab offscreenTab</span>) <span cl ass="subdued">{...}</span>;</pre>
422 <dl>
423 <div>
424 <div>
425 <dt>
426 <var>offscreenTab</var>
427 <em>
428 <!-- TYPE -->
429 <div style="display:inline">
430 (
431 <span class="optional">optional</span>
432 <span id="typeTemplate">
433 <span>
434 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
435 </span>
436 </span>
437 )
438 </div>
439 </em>
440 </dt>
441 <dd>Details of the offscreen tab.</dd>
442 <!-- OBJECT PROPERTIES -->
443 <!-- OBJECT METHODS -->
444 <!-- OBJECT EVENT FIELDS -->
445 <!-- FUNCTION PARAMETERS -->
446 </div>
447 </div>
448 </dl>
449 </div>
450 </div>
451 <!-- MIN_VERSION -->
452 </div> <!-- /description -->
453 </div><div class="apiItem">
454 <a name="method-get"></a> <!-- method-anchor -->
455 <h4>get</h4>
456 <div class="summary">
457 <!-- Note: intentionally longer 80 columns -->
458 <span>chrome.experimental.offscreenTabs.get</span>(<span class ="null"><span>integer</span>
459 <var><span>offscreenTabId</span></var></span><span class=" null"><span>, </span><span>function</span>
460 <var><span>callback</span></var></span>)</div>
461 <div class="description">
462 <p>Gets details about the specified offscreen tab.</p>
463 <!-- PARAMETERS -->
464 <h4>Parameters</h4>
465 <dl>
466 <div>
467 <div>
468 <dt>
469 <var>offscreenTabId</var>
470 <em>
471 <!-- TYPE -->
472 <div style="display:inline">
473 (
474 <span id="typeTemplate">
475 <span>
476 <span>integer</span>
477 </span>
478 </span>
479 )
480 </div>
481 </em>
482 </dt>
483 <dd>ID of the offscreen tab.</dd>
484 <!-- OBJECT PROPERTIES -->
485 <!-- OBJECT METHODS -->
486 <!-- OBJECT EVENT FIELDS -->
487 <!-- FUNCTION PARAMETERS -->
488 </div>
489 </div><div>
490 <div>
491 <dt>
492 <var>callback</var>
493 <em>
494 <!-- TYPE -->
495 <div style="display:inline">
496 (
497 <span id="typeTemplate">
498 <span>
499 <span>function</span>
500 </span>
501 </span>
502 )
503 </div>
504 </em>
505 </dt>
506 <dd class="todo">
507 Undocumented.
508 </dd>
509 <!-- OBJECT PROPERTIES -->
510 <!-- OBJECT METHODS -->
511 <!-- OBJECT EVENT FIELDS -->
512 <!-- FUNCTION PARAMETERS -->
513 </div>
514 </div>
515 </dl>
516 <!-- RETURNS -->
517 <dl>
518 </dl>
519 <!-- CALLBACK -->
520 <div>
521 <div>
522 <h4>Callback function</h4>
523 <p>
524 The <em>callback</em> parameter should specify a function
525 that looks like this:
526 </p>
527 <!-- Note: intentionally longer 80 columns -->
528 <pre>function(<span>OffscreenTab offscreenTab</span>) <span cl ass="subdued">{...}</span>;</pre>
529 <dl>
530 <div>
531 <div>
532 <dt>
533 <var>offscreenTab</var>
534 <em>
535 <!-- TYPE -->
536 <div style="display:inline">
537 (
538 <span id="typeTemplate">
539 <span>
540 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
541 </span>
542 </span>
543 )
544 </div>
545 </em>
546 </dt>
547 <dd>Details of the offscreen tab.</dd>
548 <!-- OBJECT PROPERTIES -->
549 <!-- OBJECT METHODS -->
550 <!-- OBJECT EVENT FIELDS -->
551 <!-- FUNCTION PARAMETERS -->
552 </div>
553 </div>
554 </dl>
555 </div>
556 </div>
557 <!-- MIN_VERSION -->
558 </div> <!-- /description -->
559 </div><div class="apiItem">
560 <a name="method-getAll"></a> <!-- method-anchor -->
561 <h4>getAll</h4>
562 <div class="summary">
563 <!-- Note: intentionally longer 80 columns -->
564 <span>chrome.experimental.offscreenTabs.getAll</span>(<span cl ass="null"><span>function</span>
565 <var><span>callback</span></var></span>)</div>
566 <div class="description">
567 <p>Gets an array of all offscreen tabs.</p>
568 <!-- PARAMETERS -->
569 <h4>Parameters</h4>
570 <dl>
571 <div>
572 <div>
573 <dt>
574 <var>callback</var>
575 <em>
576 <!-- TYPE -->
577 <div style="display:inline">
578 (
579 <span id="typeTemplate">
580 <span>
581 <span>function</span>
582 </span>
583 </span>
584 )
585 </div>
586 </em>
587 </dt>
588 <dd class="todo">
589 Undocumented.
590 </dd>
591 <!-- OBJECT PROPERTIES -->
592 <!-- OBJECT METHODS -->
593 <!-- OBJECT EVENT FIELDS -->
594 <!-- FUNCTION PARAMETERS -->
595 </div>
596 </div>
597 </dl>
598 <!-- RETURNS -->
599 <dl>
600 </dl>
601 <!-- CALLBACK -->
602 <div>
603 <div>
604 <h4>Callback function</h4>
605 <p>
606 The <em>callback</em> parameter should specify a function
607 that looks like this:
608 </p>
609 <!-- Note: intentionally longer 80 columns -->
610 <pre>function(<span>array of OffscreenTab offscreenTabs</span> ) <span class="subdued">{...}</span>;</pre>
611 <dl>
612 <div>
613 <div>
614 <dt>
615 <var>offscreenTabs</var>
616 <em>
617 <!-- TYPE -->
618 <div style="display:inline">
619 (
620 <span id="typeTemplate">
621 <span>
622 <span>
623 array of <span><span>
624 <span>
625 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
626 </span>
627 </span></span>
628 </span>
629 </span>
630 </span>
631 )
632 </div>
633 </em>
634 </dt>
635 <dd class="todo">
636 Undocumented.
637 </dd>
638 <!-- OBJECT PROPERTIES -->
639 <!-- OBJECT METHODS -->
640 <!-- OBJECT EVENT FIELDS -->
641 <!-- FUNCTION PARAMETERS -->
642 </div>
643 </div>
644 </dl>
645 </div>
646 </div>
647 <!-- MIN_VERSION -->
648 </div> <!-- /description -->
649 </div><div class="apiItem">
650 <a name="method-remove"></a> <!-- method-anchor -->
651 <h4>remove</h4>
652 <div class="summary">
653 <!-- Note: intentionally longer 80 columns -->
654 <span>chrome.experimental.offscreenTabs.remove</span>(<span cl ass="null"><span>integer</span>
655 <var><span>offscreenTabId</span></var></span><span class=" optional"><span>, </span><span>function</span>
656 <var><span>callback</span></var></span>)</div>
657 <div class="description">
658 <p>Removes an offscreen tab.</p>
659 <!-- PARAMETERS -->
660 <h4>Parameters</h4>
661 <dl>
662 <div>
663 <div>
664 <dt>
665 <var>offscreenTabId</var>
666 <em>
667 <!-- TYPE -->
668 <div style="display:inline">
669 (
670 <span id="typeTemplate">
671 <span>
672 <span>integer</span>
673 </span>
674 </span>
675 )
676 </div>
677 </em>
678 </dt>
679 <dd>ID of the offscreen tab.</dd>
680 <!-- OBJECT PROPERTIES -->
681 <!-- OBJECT METHODS -->
682 <!-- OBJECT EVENT FIELDS -->
683 <!-- FUNCTION PARAMETERS -->
684 </div>
685 </div><div>
686 <div>
687 <dt>
688 <var>callback</var>
689 <em>
690 <!-- TYPE -->
691 <div style="display:inline">
692 (
693 <span class="optional">optional</span>
694 <span id="typeTemplate">
695 <span>
696 <span>function</span>
697 </span>
698 </span>
699 )
700 </div>
701 </em>
702 </dt>
703 <dd class="todo">
704 Undocumented.
705 </dd>
706 <!-- OBJECT PROPERTIES -->
707 <!-- OBJECT METHODS -->
708 <!-- OBJECT EVENT FIELDS -->
709 <!-- FUNCTION PARAMETERS -->
710 </div>
711 </div>
712 </dl>
713 <!-- RETURNS -->
714 <dl>
715 </dl>
716 <!-- CALLBACK -->
717 <div>
718 <div>
719 <h4>Callback function</h4>
720 <p>
721 If you specify the <em>callback</em> parameter, it should
722 specify a function that looks like this:
723 </p>
724 <!-- Note: intentionally longer 80 columns -->
725 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
726 <dl>
727 </dl>
728 </div>
729 </div>
730 <!-- MIN_VERSION -->
731 </div> <!-- /description -->
732 </div><div class="apiItem">
733 <a name="method-sendKeyboardEvent"></a> <!-- method-anchor -->
734 <h4>sendKeyboardEvent</h4>
735 <div class="summary">
736 <!-- Note: intentionally longer 80 columns -->
737 <span>chrome.experimental.offscreenTabs.sendKeyboardEvent</spa n>(<span class="null"><span>integer</span>
738 <var><span>offscreenTabId</span></var></span><span class=" null"><span>, </span><span>KeyboardEvent</span>
739 <var><span>keyboardEvent</span></var></span><span class="o ptional"><span>, </span><span>function</span>
740 <var><span>callback</span></var></span>)</div>
741 <div class="description">
742 <p>Dispatches a keyboard event in the offscreen tab.</p>
743 <!-- PARAMETERS -->
744 <h4>Parameters</h4>
745 <dl>
746 <div>
747 <div>
748 <dt>
749 <var>offscreenTabId</var>
750 <em>
751 <!-- TYPE -->
752 <div style="display:inline">
753 (
754 <span id="typeTemplate">
755 <span>
756 <span>integer</span>
757 </span>
758 </span>
759 )
760 </div>
761 </em>
762 </dt>
763 <dd>ID of the offscreen tab.</dd>
764 <!-- OBJECT PROPERTIES -->
765 <!-- OBJECT METHODS -->
766 <!-- OBJECT EVENT FIELDS -->
767 <!-- FUNCTION PARAMETERS -->
768 </div>
769 </div><div>
770 <div>
771 <dt>
772 <var>keyboardEvent</var>
773 <em>
774 <!-- TYPE -->
775 <div style="display:inline">
776 (
777 <span id="typeTemplate">
778 <span>
779 <a href="input.ime.html#type-KeyboardEvent">KeyboardEven t</a>
780 </span>
781 </span>
782 )
783 </div>
784 </em>
785 </dt>
786 <dd>A JavaScript KeyboardEvent object. Supported event types: <i>keydo wn</i>, <i>keyup</i>, <i>keypress</i>. Note, only <i>keypress</i> produces a vis ible result on screen.</dd>
787 <!-- OBJECT PROPERTIES -->
788 <!-- OBJECT METHODS -->
789 <!-- OBJECT EVENT FIELDS -->
790 <!-- FUNCTION PARAMETERS -->
791 </div>
792 </div><div>
793 <div>
794 <dt>
795 <var>callback</var>
796 <em>
797 <!-- TYPE -->
798 <div style="display:inline">
799 (
800 <span class="optional">optional</span>
801 <span id="typeTemplate">
802 <span>
803 <span>function</span>
804 </span>
805 </span>
806 )
807 </div>
808 </em>
809 </dt>
810 <dd class="todo">
811 Undocumented.
812 </dd>
813 <!-- OBJECT PROPERTIES -->
814 <!-- OBJECT METHODS -->
815 <!-- OBJECT EVENT FIELDS -->
816 <!-- FUNCTION PARAMETERS -->
817 </div>
818 </div>
819 </dl>
820 <!-- RETURNS -->
821 <dl>
822 </dl>
823 <!-- CALLBACK -->
824 <div>
825 <div>
826 <h4>Callback function</h4>
827 <p>
828 If you specify the <em>callback</em> parameter, it should
829 specify a function that looks like this:
830 </p>
831 <!-- Note: intentionally longer 80 columns -->
832 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
833 <dl>
834 </dl>
835 </div>
836 </div>
837 <!-- MIN_VERSION -->
838 </div> <!-- /description -->
839 </div><div class="apiItem">
840 <a name="method-sendMouseEvent"></a> <!-- method-anchor -->
841 <h4>sendMouseEvent</h4>
842 <div class="summary">
843 <!-- Note: intentionally longer 80 columns -->
844 <span>chrome.experimental.offscreenTabs.sendMouseEvent</span>( <span class="null"><span>integer</span>
845 <var><span>offscreenTabId</span></var></span><span class=" null"><span>, </span><span>MouseEvent</span>
846 <var><span>mouseEvent</span></var></span><span class="opti onal"><span>, </span><span>object</span>
847 <var><span>position</span></var></span><span class="option al"><span>, </span><span>function</span>
848 <var><span>callback</span></var></span>)</div>
849 <div class="description">
850 <p>Dispatches a mouse event in the offscreen tab.</p>
851 <!-- PARAMETERS -->
852 <h4>Parameters</h4>
853 <dl>
854 <div>
855 <div>
856 <dt>
857 <var>offscreenTabId</var>
858 <em>
859 <!-- TYPE -->
860 <div style="display:inline">
861 (
862 <span id="typeTemplate">
863 <span>
864 <span>integer</span>
865 </span>
866 </span>
867 )
868 </div>
869 </em>
870 </dt>
871 <dd>ID of the offscreen tab.</dd>
872 <!-- OBJECT PROPERTIES -->
873 <!-- OBJECT METHODS -->
874 <!-- OBJECT EVENT FIELDS -->
875 <!-- FUNCTION PARAMETERS -->
876 </div>
877 </div><div>
878 <div>
879 <dt>
880 <var>mouseEvent</var>
881 <em>
882 <!-- TYPE -->
883 <div style="display:inline">
884 (
885 <span id="typeTemplate">
886 <span>
887 <a href="experimental.offscreenTabs.html#type-MouseEvent ">MouseEvent</a>
888 </span>
889 </span>
890 )
891 </div>
892 </em>
893 </dt>
894 <dd>A JavaScript MouseEvent object. Supported event types: <i>mousedow n</i>, <i>mouseup</i>, <i>click</i>, <i>mousemove</i>, <i>mousewheel</i>.</dd>
895 <!-- OBJECT PROPERTIES -->
896 <!-- OBJECT METHODS -->
897 <!-- OBJECT EVENT FIELDS -->
898 <!-- FUNCTION PARAMETERS -->
899 </div>
900 </div><div>
901 <div>
902 <dt>
903 <var>position</var>
904 <em>
905 <!-- TYPE -->
906 <div style="display:inline">
907 (
908 <span class="optional">optional</span>
909 <span id="typeTemplate">
910 <span>
911 <span>object</span>
912 </span>
913 </span>
914 )
915 </div>
916 </em>
917 </dt>
918 <dd>The position where the mouse event should be dispatched within the offscreen page. Not required for mousewheel events.</dd>
919 <!-- OBJECT PROPERTIES -->
920 <dd>
921 <dl>
922 <div>
923 <div>
924 <dt>
925 <var>x</var>
926 <em>
927 <!-- TYPE -->
928 <div style="display:inline">
929 (
930 <span id="typeTemplate">
931 <span>
932 <span>integer</span>
933 </span>
934 </span>
935 )
936 </div>
937 </em>
938 </dt>
939 <dd class="todo">
940 Undocumented.
941 </dd>
942 <!-- OBJECT PROPERTIES -->
943 <!-- OBJECT METHODS -->
944 <!-- OBJECT EVENT FIELDS -->
945 <!-- FUNCTION PARAMETERS -->
946 </div>
947 </div><div>
948 <div>
949 <dt>
950 <var>y</var>
951 <em>
952 <!-- TYPE -->
953 <div style="display:inline">
954 (
955 <span id="typeTemplate">
956 <span>
957 <span>integer</span>
958 </span>
959 </span>
960 )
961 </div>
962 </em>
963 </dt>
964 <dd class="todo">
965 Undocumented.
966 </dd>
967 <!-- OBJECT PROPERTIES -->
968 <!-- OBJECT METHODS -->
969 <!-- OBJECT EVENT FIELDS -->
970 <!-- FUNCTION PARAMETERS -->
971 </div>
972 </div>
973 </dl>
974 </dd>
975 <!-- OBJECT METHODS -->
976 <!-- OBJECT EVENT FIELDS -->
977 <!-- FUNCTION PARAMETERS -->
978 </div>
979 </div><div>
980 <div>
981 <dt>
982 <var>callback</var>
983 <em>
984 <!-- TYPE -->
985 <div style="display:inline">
986 (
987 <span class="optional">optional</span>
988 <span id="typeTemplate">
989 <span>
990 <span>function</span>
991 </span>
992 </span>
993 )
994 </div>
995 </em>
996 </dt>
997 <dd class="todo">
998 Undocumented.
999 </dd>
1000 <!-- OBJECT PROPERTIES -->
1001 <!-- OBJECT METHODS -->
1002 <!-- OBJECT EVENT FIELDS -->
1003 <!-- FUNCTION PARAMETERS -->
1004 </div>
1005 </div>
1006 </dl>
1007 <!-- RETURNS -->
1008 <dl>
1009 </dl>
1010 <!-- CALLBACK -->
1011 <div>
1012 <div>
1013 <h4>Callback function</h4>
1014 <p>
1015 If you specify the <em>callback</em> parameter, it should
1016 specify a function that looks like this:
1017 </p>
1018 <!-- Note: intentionally longer 80 columns -->
1019 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1020 <dl>
1021 </dl>
1022 </div>
1023 </div>
1024 <!-- MIN_VERSION -->
1025 </div> <!-- /description -->
1026 </div><div class="apiItem">
1027 <a name="method-toDataUrl"></a> <!-- method-anchor -->
1028 <h4>toDataUrl</h4>
1029 <div class="summary">
1030 <!-- Note: intentionally longer 80 columns -->
1031 <span>chrome.experimental.offscreenTabs.toDataUrl</span>(<span class="null"><span>integer</span>
1032 <var><span>offscreenTabId</span></var></span><span class=" optional"><span>, </span><span>object</span>
1033 <var><span>options</span></var></span><span class="null">< span>, </span><span>function</span>
1034 <var><span>callback</span></var></span>)</div>
1035 <div class="description">
1036 <p>Captures the visible area of an offscreen tab. </p>
1037 <!-- PARAMETERS -->
1038 <h4>Parameters</h4>
1039 <dl>
1040 <div>
1041 <div>
1042 <dt>
1043 <var>offscreenTabId</var>
1044 <em>
1045 <!-- TYPE -->
1046 <div style="display:inline">
1047 (
1048 <span id="typeTemplate">
1049 <span>
1050 <span>integer</span>
1051 </span>
1052 </span>
1053 )
1054 </div>
1055 </em>
1056 </dt>
1057 <dd>The ID of the offscreen tab.</dd>
1058 <!-- OBJECT PROPERTIES -->
1059 <!-- OBJECT METHODS -->
1060 <!-- OBJECT EVENT FIELDS -->
1061 <!-- FUNCTION PARAMETERS -->
1062 </div>
1063 </div><div>
1064 <div>
1065 <dt>
1066 <var>options</var>
1067 <em>
1068 <!-- TYPE -->
1069 <div style="display:inline">
1070 (
1071 <span class="optional">optional</span>
1072 <span id="typeTemplate">
1073 <span>
1074 <span>object</span>
1075 </span>
1076 </span>
1077 )
1078 </div>
1079 </em>
1080 </dt>
1081 <dd>Set parameters of image capture, such as the format of the resulti ng image.</dd>
1082 <!-- OBJECT PROPERTIES -->
1083 <dd>
1084 <dl>
1085 <div>
1086 <div>
1087 <dt>
1088 <var>format</var>
1089 <em>
1090 <!-- TYPE -->
1091 <div style="display:inline">
1092 (
1093 <span class="optional">optional</span>
1094 <span class="enum">enumerated</span>
1095 <span id="typeTemplate">
1096 <span>
1097 <span>string</span>
1098 <span>["jpeg", "png"]</span>
1099 </span>
1100 </span>
1101 )
1102 </div>
1103 </em>
1104 </dt>
1105 <dd>The format of the resulting image. Default is jpeg.</dd>
1106 <!-- OBJECT PROPERTIES -->
1107 <!-- OBJECT METHODS -->
1108 <!-- OBJECT EVENT FIELDS -->
1109 <!-- FUNCTION PARAMETERS -->
1110 </div>
1111 </div><div>
1112 <div>
1113 <dt>
1114 <var>quality</var>
1115 <em>
1116 <!-- TYPE -->
1117 <div style="display:inline">
1118 (
1119 <span class="optional">optional</span>
1120 <span id="typeTemplate">
1121 <span>
1122 <span>integer</span>
1123 </span>
1124 </span>
1125 )
1126 </div>
1127 </em>
1128 </dt>
1129 <dd>When format is 'jpeg', controls the quality of the resulting image . This value is ignored for PNG images. As quality is decreased, the resulting i mage will have more visual artifacts, and the number of bytes needed to store it will decrease.</dd>
1130 <!-- OBJECT PROPERTIES -->
1131 <!-- OBJECT METHODS -->
1132 <!-- OBJECT EVENT FIELDS -->
1133 <!-- FUNCTION PARAMETERS -->
1134 </div>
1135 </div>
1136 </dl>
1137 </dd>
1138 <!-- OBJECT METHODS -->
1139 <!-- OBJECT EVENT FIELDS -->
1140 <!-- FUNCTION PARAMETERS -->
1141 </div>
1142 </div><div>
1143 <div>
1144 <dt>
1145 <var>callback</var>
1146 <em>
1147 <!-- TYPE -->
1148 <div style="display:inline">
1149 (
1150 <span id="typeTemplate">
1151 <span>
1152 <span>function</span>
1153 </span>
1154 </span>
1155 )
1156 </div>
1157 </em>
1158 </dt>
1159 <dd class="todo">
1160 Undocumented.
1161 </dd>
1162 <!-- OBJECT PROPERTIES -->
1163 <!-- OBJECT METHODS -->
1164 <!-- OBJECT EVENT FIELDS -->
1165 <!-- FUNCTION PARAMETERS -->
1166 </div>
1167 </div>
1168 </dl>
1169 <!-- RETURNS -->
1170 <dl>
1171 </dl>
1172 <!-- CALLBACK -->
1173 <div>
1174 <div>
1175 <h4>Callback function</h4>
1176 <p>
1177 The <em>callback</em> parameter should specify a function
1178 that looks like this:
1179 </p>
1180 <!-- Note: intentionally longer 80 columns -->
1181 <pre>function(<span>string dataUrl</span>) <span class="subdue d">{...}</span>;</pre>
1182 <dl>
1183 <div>
1184 <div>
1185 <dt>
1186 <var>dataUrl</var>
1187 <em>
1188 <!-- TYPE -->
1189 <div style="display:inline">
1190 (
1191 <span id="typeTemplate">
1192 <span>
1193 <span>string</span>
1194 </span>
1195 </span>
1196 )
1197 </div>
1198 </em>
1199 </dt>
1200 <dd>A data URL which encodes an image of the visible area of the captu red offscreen tab. May be assigned to the 'src' property of an HTML Image elemen t or WebGL texture source for display.</dd>
1201 <!-- OBJECT PROPERTIES -->
1202 <!-- OBJECT METHODS -->
1203 <!-- OBJECT EVENT FIELDS -->
1204 <!-- FUNCTION PARAMETERS -->
1205 </div>
1206 </div>
1207 </dl>
1208 </div>
1209 </div>
1210 <!-- MIN_VERSION -->
1211 </div> <!-- /description -->
1212 </div><div class="apiItem">
1213 <a name="method-update"></a> <!-- method-anchor -->
1214 <h4>update</h4>
1215 <div class="summary">
1216 <!-- Note: intentionally longer 80 columns -->
1217 <span>chrome.experimental.offscreenTabs.update</span>(<span cl ass="null"><span>integer</span>
1218 <var><span>offscreenTabId</span></var></span><span class=" null"><span>, </span><span>object</span>
1219 <var><span>updateProperties</span></var></span><span class ="optional"><span>, </span><span>function</span>
1220 <var><span>callback</span></var></span>)</div>
1221 <div class="description">
1222 <p>Modifies the properties of an offscreen tab. Properties that are not specified in updateProperties are not modified.</p>
1223 <!-- PARAMETERS -->
1224 <h4>Parameters</h4>
1225 <dl>
1226 <div>
1227 <div>
1228 <dt>
1229 <var>offscreenTabId</var>
1230 <em>
1231 <!-- TYPE -->
1232 <div style="display:inline">
1233 (
1234 <span id="typeTemplate">
1235 <span>
1236 <span>integer</span>
1237 </span>
1238 </span>
1239 )
1240 </div>
1241 </em>
1242 </dt>
1243 <dd>The ID of the offscreen tab.</dd>
1244 <!-- OBJECT PROPERTIES -->
1245 <!-- OBJECT METHODS -->
1246 <!-- OBJECT EVENT FIELDS -->
1247 <!-- FUNCTION PARAMETERS -->
1248 </div>
1249 </div><div>
1250 <div>
1251 <dt>
1252 <var>updateProperties</var>
1253 <em>
1254 <!-- TYPE -->
1255 <div style="display:inline">
1256 (
1257 <span id="typeTemplate">
1258 <span>
1259 <span>object</span>
1260 </span>
1261 </span>
1262 )
1263 </div>
1264 </em>
1265 </dt>
1266 <dd class="todo">
1267 Undocumented.
1268 </dd>
1269 <!-- OBJECT PROPERTIES -->
1270 <dd>
1271 <dl>
1272 <div>
1273 <div>
1274 <dt>
1275 <var>url</var>
1276 <em>
1277 <!-- TYPE -->
1278 <div style="display:inline">
1279 (
1280 <span class="optional">optional</span>
1281 <span id="typeTemplate">
1282 <span>
1283 <span>string</span>
1284 </span>
1285 </span>
1286 )
1287 </div>
1288 </em>
1289 </dt>
1290 <dd>The URL the offscreen tab is displaying.</dd>
1291 <!-- OBJECT PROPERTIES -->
1292 <!-- OBJECT METHODS -->
1293 <!-- OBJECT EVENT FIELDS -->
1294 <!-- FUNCTION PARAMETERS -->
1295 </div>
1296 </div><div>
1297 <div>
1298 <dt>
1299 <var>width</var>
1300 <em>
1301 <!-- TYPE -->
1302 <div style="display:inline">
1303 (
1304 <span class="optional">optional</span>
1305 <span id="typeTemplate">
1306 <span>
1307 <span>integer</span>
1308 </span>
1309 </span>
1310 )
1311 </div>
1312 </em>
1313 </dt>
1314 <dd>Width of the window.</dd>
1315 <!-- OBJECT PROPERTIES -->
1316 <!-- OBJECT METHODS -->
1317 <!-- OBJECT EVENT FIELDS -->
1318 <!-- FUNCTION PARAMETERS -->
1319 </div>
1320 </div><div>
1321 <div>
1322 <dt>
1323 <var>height</var>
1324 <em>
1325 <!-- TYPE -->
1326 <div style="display:inline">
1327 (
1328 <span class="optional">optional</span>
1329 <span id="typeTemplate">
1330 <span>
1331 <span>integer</span>
1332 </span>
1333 </span>
1334 )
1335 </div>
1336 </em>
1337 </dt>
1338 <dd>Height of the window.</dd>
1339 <!-- OBJECT PROPERTIES -->
1340 <!-- OBJECT METHODS -->
1341 <!-- OBJECT EVENT FIELDS -->
1342 <!-- FUNCTION PARAMETERS -->
1343 </div>
1344 </div>
1345 </dl>
1346 </dd>
1347 <!-- OBJECT METHODS -->
1348 <!-- OBJECT EVENT FIELDS -->
1349 <!-- FUNCTION PARAMETERS -->
1350 </div>
1351 </div><div>
1352 <div>
1353 <dt>
1354 <var>callback</var>
1355 <em>
1356 <!-- TYPE -->
1357 <div style="display:inline">
1358 (
1359 <span class="optional">optional</span>
1360 <span id="typeTemplate">
1361 <span>
1362 <span>function</span>
1363 </span>
1364 </span>
1365 )
1366 </div>
1367 </em>
1368 </dt>
1369 <dd class="todo">
1370 Undocumented.
1371 </dd>
1372 <!-- OBJECT PROPERTIES -->
1373 <!-- OBJECT METHODS -->
1374 <!-- OBJECT EVENT FIELDS -->
1375 <!-- FUNCTION PARAMETERS -->
1376 </div>
1377 </div>
1378 </dl>
1379 <!-- RETURNS -->
1380 <dl>
1381 </dl>
1382 <!-- CALLBACK -->
1383 <div>
1384 <div>
1385 <h4>Callback function</h4>
1386 <p>
1387 If you specify the <em>callback</em> parameter, it should
1388 specify a function that looks like this:
1389 </p>
1390 <!-- Note: intentionally longer 80 columns -->
1391 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1392 <dl>
1393 </dl>
1394 </div>
1395 </div>
1396 <!-- MIN_VERSION -->
1397 </div> <!-- /description -->
1398 </div> <!-- /apiItem -->
1399 </div> <!-- /apiGroup -->
1400 <!-- EVENTS -->
1401 <div id="eventsTemplate" class="apiGroup">
1402 <a name="global-events"></a>
1403 <h3>Events</h3>
1404 <!-- iterates over all events -->
1405 <div class="apiItem">
1406 <a name="event-onUpdated"></a>
1407 <h4>onUpdated</h4>
1408 <div class="summary">
1409 <!-- Note: intentionally longer 80 columns -->
1410 <span class="subdued">chrome.experimental.offscreenTabs.</span>< span>onUpdated</span><span class="subdued">.addListener</span>(function(<span>in teger offscreenTabId, object changeInfo, OffscreenTab offscreenTab</span>) <span class="subdued">{...}</span><span></span>);
1411 </div>
1412 <div class="description">
1413 <p>Fires when an offscreen tab is updated. </p>
1414 <!-- LISTENER PARAMETERS -->
1415 <div>
1416 <h4>Listener parameters</h4>
1417 <dl>
1418 <div>
1419 <div>
1420 <dt>
1421 <var>offscreenTabId</var>
1422 <em>
1423 <!-- TYPE -->
1424 <div style="display:inline">
1425 (
1426 <span id="typeTemplate">
1427 <span>
1428 <span>integer</span>
1429 </span>
1430 </span>
1431 )
1432 </div>
1433 </em>
1434 </dt>
1435 <dd>ID of the updated offscreen tab</dd>
1436 <!-- OBJECT PROPERTIES -->
1437 <!-- OBJECT METHODS -->
1438 <!-- OBJECT EVENT FIELDS -->
1439 <!-- FUNCTION PARAMETERS -->
1440 </div>
1441 </div><div>
1442 <div>
1443 <dt>
1444 <var>changeInfo</var>
1445 <em>
1446 <!-- TYPE -->
1447 <div style="display:inline">
1448 (
1449 <span id="typeTemplate">
1450 <span>
1451 <span>object</span>
1452 </span>
1453 </span>
1454 )
1455 </div>
1456 </em>
1457 </dt>
1458 <dd>Lists the changes to the state of the offscreen tab that was updat ed.</dd>
1459 <!-- OBJECT PROPERTIES -->
1460 <dd>
1461 <dl>
1462 <div>
1463 <div>
1464 <dt>
1465 <var>url</var>
1466 <em>
1467 <!-- TYPE -->
1468 <div style="display:inline">
1469 (
1470 <span class="optional">optional</span>
1471 <span id="typeTemplate">
1472 <span>
1473 <span>string</span>
1474 </span>
1475 </span>
1476 )
1477 </div>
1478 </em>
1479 </dt>
1480 <dd>The offscreen tab's URL if it has changed.</dd>
1481 <!-- OBJECT PROPERTIES -->
1482 <!-- OBJECT METHODS -->
1483 <!-- OBJECT EVENT FIELDS -->
1484 <!-- FUNCTION PARAMETERS -->
1485 </div>
1486 </div>
1487 </dl>
1488 </dd>
1489 <!-- OBJECT METHODS -->
1490 <!-- OBJECT EVENT FIELDS -->
1491 <!-- FUNCTION PARAMETERS -->
1492 </div>
1493 </div><div>
1494 <div>
1495 <dt>
1496 <var>offscreenTab</var>
1497 <em>
1498 <!-- TYPE -->
1499 <div style="display:inline">
1500 (
1501 <span id="typeTemplate">
1502 <span>
1503 <a href="experimental.offscreenTabs.html#type-OffscreenT ab">OffscreenTab</a>
1504 </span>
1505 </span>
1506 )
1507 </div>
1508 </em>
1509 </dt>
1510 <dd>Details of the offscreen tab.</dd>
1511 <!-- OBJECT PROPERTIES -->
1512 <!-- OBJECT METHODS -->
1513 <!-- OBJECT EVENT FIELDS -->
1514 <!-- FUNCTION PARAMETERS -->
1515 </div>
1516 </div>
1517 </dl>
1518 </div>
1519 <!-- EXTRA PARAMETERS -->
1520 <!-- LISTENER RETURN VALUE -->
1521 <dl>
1522 </dl>
1523 </div> <!-- /description -->
1524 <!-- /description -->
1525 </div> <!-- /apiItem -->
1526 </div> <!-- /apiGroup -->
1527 <!-- TYPES -->
1528 <div class="apiGroup">
1529 <a name="types"></a>
1530 <h3 id="types">Types</h3>
1531 <!-- iterates over all types -->
1532 <div class="apiItem">
1533 <a name="type-OffscreenTab"></a>
1534 <h4>OffscreenTab</h4>
1535 <div>
1536 <dt>
1537 <em>
1538 <!-- TYPE -->
1539 <div style="display:inline">
1540 (
1541 <span id="typeTemplate">
1542 <span>
1543 <span>object</span>
1544 </span>
1545 </span>
1546 )
1547 </div>
1548 </em>
1549 </dt>
1550 <dd class="todo">
1551 Undocumented.
1552 </dd>
1553 <!-- OBJECT PROPERTIES -->
1554 <dd>
1555 <dl>
1556 <div>
1557 <div>
1558 <dt>
1559 <var>id</var>
1560 <em>
1561 <!-- TYPE -->
1562 <div style="display:inline">
1563 (
1564 <span id="typeTemplate">
1565 <span>
1566 <span>integer</span>
1567 </span>
1568 </span>
1569 )
1570 </div>
1571 </em>
1572 </dt>
1573 <dd>The ID of the offscreen tab. Tab IDs are unique within a browser s ession.</dd>
1574 <!-- OBJECT PROPERTIES -->
1575 <!-- OBJECT METHODS -->
1576 <!-- OBJECT EVENT FIELDS -->
1577 <!-- FUNCTION PARAMETERS -->
1578 </div>
1579 </div><div>
1580 <div>
1581 <dt>
1582 <var>url</var>
1583 <em>
1584 <!-- TYPE -->
1585 <div style="display:inline">
1586 (
1587 <span id="typeTemplate">
1588 <span>
1589 <span>string</span>
1590 </span>
1591 </span>
1592 )
1593 </div>
1594 </em>
1595 </dt>
1596 <dd>URL of the offscreen tab.</dd>
1597 <!-- OBJECT PROPERTIES -->
1598 <!-- OBJECT METHODS -->
1599 <!-- OBJECT EVENT FIELDS -->
1600 <!-- FUNCTION PARAMETERS -->
1601 </div>
1602 </div><div>
1603 <div>
1604 <dt>
1605 <var>width</var>
1606 <em>
1607 <!-- TYPE -->
1608 <div style="display:inline">
1609 (
1610 <span id="typeTemplate">
1611 <span>
1612 <span>integer</span>
1613 </span>
1614 </span>
1615 )
1616 </div>
1617 </em>
1618 </dt>
1619 <dd>Width of the window.</dd>
1620 <!-- OBJECT PROPERTIES -->
1621 <!-- OBJECT METHODS -->
1622 <!-- OBJECT EVENT FIELDS -->
1623 <!-- FUNCTION PARAMETERS -->
1624 </div>
1625 </div><div>
1626 <div>
1627 <dt>
1628 <var>height</var>
1629 <em>
1630 <!-- TYPE -->
1631 <div style="display:inline">
1632 (
1633 <span id="typeTemplate">
1634 <span>
1635 <span>integer</span>
1636 </span>
1637 </span>
1638 )
1639 </div>
1640 </em>
1641 </dt>
1642 <dd>Height of the window.</dd>
1643 <!-- OBJECT PROPERTIES -->
1644 <!-- OBJECT METHODS -->
1645 <!-- OBJECT EVENT FIELDS -->
1646 <!-- FUNCTION PARAMETERS -->
1647 </div>
1648 </div>
1649 </dl>
1650 </dd>
1651 <!-- OBJECT METHODS -->
1652 <!-- OBJECT EVENT FIELDS -->
1653 <!-- FUNCTION PARAMETERS -->
1654 </div>
1655 </div><div class="apiItem">
1656 <a name="type-MouseEvent"></a>
1657 <h4>MouseEvent</h4>
1658 <div>
1659 <dt>
1660 <em>
1661 <!-- TYPE -->
1662 <div style="display:inline">
1663 (
1664 <span id="typeTemplate">
1665 <span>
1666 <span>object</span>
1667 </span>
1668 </span>
1669 )
1670 </div>
1671 </em>
1672 </dt>
1673 <dd class="todo">
1674 Undocumented.
1675 </dd>
1676 <!-- OBJECT PROPERTIES -->
1677 <dd>
1678 <dl>
1679 <div>
1680 <div>
1681 <dt>
1682 <var>type</var>
1683 <em>
1684 <!-- TYPE -->
1685 <div style="display:inline">
1686 (
1687 <span class="enum">enumerated</span>
1688 <span id="typeTemplate">
1689 <span>
1690 <span>string</span>
1691 <span>["mousedown", "mouseup", "click", "mousemove", "mo usewheel"]</span>
1692 </span>
1693 </span>
1694 )
1695 </div>
1696 </em>
1697 </dt>
1698 <dd class="todo">
1699 Undocumented.
1700 </dd>
1701 <!-- OBJECT PROPERTIES -->
1702 <!-- OBJECT METHODS -->
1703 <!-- OBJECT EVENT FIELDS -->
1704 <!-- FUNCTION PARAMETERS -->
1705 </div>
1706 </div><div>
1707 <div>
1708 <dt>
1709 <var>button</var>
1710 <em>
1711 <!-- TYPE -->
1712 <div style="display:inline">
1713 (
1714 <span class="optional">optional</span>
1715 <span id="typeTemplate">
1716 <span>
1717 <span>integer</span>
1718 </span>
1719 </span>
1720 )
1721 </div>
1722 </em>
1723 </dt>
1724 <dd class="todo">
1725 Undocumented.
1726 </dd>
1727 <!-- OBJECT PROPERTIES -->
1728 <!-- OBJECT METHODS -->
1729 <!-- OBJECT EVENT FIELDS -->
1730 <!-- FUNCTION PARAMETERS -->
1731 </div>
1732 </div><div>
1733 <div>
1734 <dt>
1735 <var>wheelDeltaX</var>
1736 <em>
1737 <!-- TYPE -->
1738 <div style="display:inline">
1739 (
1740 <span class="optional">optional</span>
1741 <span id="typeTemplate">
1742 <span>
1743 <span>integer</span>
1744 </span>
1745 </span>
1746 )
1747 </div>
1748 </em>
1749 </dt>
1750 <dd class="todo">
1751 Undocumented.
1752 </dd>
1753 <!-- OBJECT PROPERTIES -->
1754 <!-- OBJECT METHODS -->
1755 <!-- OBJECT EVENT FIELDS -->
1756 <!-- FUNCTION PARAMETERS -->
1757 </div>
1758 </div><div>
1759 <div>
1760 <dt>
1761 <var>wheelDeltaY</var>
1762 <em>
1763 <!-- TYPE -->
1764 <div style="display:inline">
1765 (
1766 <span class="optional">optional</span>
1767 <span id="typeTemplate">
1768 <span>
1769 <span>integer</span>
1770 </span>
1771 </span>
1772 )
1773 </div>
1774 </em>
1775 </dt>
1776 <dd class="todo">
1777 Undocumented.
1778 </dd>
1779 <!-- OBJECT PROPERTIES -->
1780 <!-- OBJECT METHODS -->
1781 <!-- OBJECT EVENT FIELDS -->
1782 <!-- FUNCTION PARAMETERS -->
1783 </div>
1784 </div><div>
1785 <div>
1786 <dt>
1787 <var>altKey</var>
1788 <em>
1789 <!-- TYPE -->
1790 <div style="display:inline">
1791 (
1792 <span id="typeTemplate">
1793 <span>
1794 <span>boolean</span>
1795 </span>
1796 </span>
1797 )
1798 </div>
1799 </em>
1800 </dt>
1801 <dd class="todo">
1802 Undocumented.
1803 </dd>
1804 <!-- OBJECT PROPERTIES -->
1805 <!-- OBJECT METHODS -->
1806 <!-- OBJECT EVENT FIELDS -->
1807 <!-- FUNCTION PARAMETERS -->
1808 </div>
1809 </div><div>
1810 <div>
1811 <dt>
1812 <var>ctrlKey</var>
1813 <em>
1814 <!-- TYPE -->
1815 <div style="display:inline">
1816 (
1817 <span id="typeTemplate">
1818 <span>
1819 <span>boolean</span>
1820 </span>
1821 </span>
1822 )
1823 </div>
1824 </em>
1825 </dt>
1826 <dd class="todo">
1827 Undocumented.
1828 </dd>
1829 <!-- OBJECT PROPERTIES -->
1830 <!-- OBJECT METHODS -->
1831 <!-- OBJECT EVENT FIELDS -->
1832 <!-- FUNCTION PARAMETERS -->
1833 </div>
1834 </div><div>
1835 <div>
1836 <dt>
1837 <var>shiftKey</var>
1838 <em>
1839 <!-- TYPE -->
1840 <div style="display:inline">
1841 (
1842 <span id="typeTemplate">
1843 <span>
1844 <span>boolean</span>
1845 </span>
1846 </span>
1847 )
1848 </div>
1849 </em>
1850 </dt>
1851 <dd class="todo">
1852 Undocumented.
1853 </dd>
1854 <!-- OBJECT PROPERTIES -->
1855 <!-- OBJECT METHODS -->
1856 <!-- OBJECT EVENT FIELDS -->
1857 <!-- FUNCTION PARAMETERS -->
1858 </div>
1859 </div><div>
1860 <div>
1861 <dt>
1862 <var>metaKey</var>
1863 <em>
1864 <!-- TYPE -->
1865 <div style="display:inline">
1866 (
1867 <span class="optional">optional</span>
1868 <span id="typeTemplate">
1869 <span>
1870 <span>boolean</span>
1871 </span>
1872 </span>
1873 )
1874 </div>
1875 </em>
1876 </dt>
1877 <dd class="todo">
1878 Undocumented.
1879 </dd>
1880 <!-- OBJECT PROPERTIES -->
1881 <!-- OBJECT METHODS -->
1882 <!-- OBJECT EVENT FIELDS -->
1883 <!-- FUNCTION PARAMETERS -->
1884 </div>
1885 </div>
1886 </dl>
1887 </dd>
1888 <!-- OBJECT METHODS -->
1889 <!-- OBJECT EVENT FIELDS -->
1890 <!-- FUNCTION PARAMETERS -->
1891 </div>
1892 </div><div class="apiItem">
1893 <a name="type-KeyboardEvent"></a>
1894 <h4>KeyboardEvent</h4>
1895 <div>
1896 <dt>
1897 <em>
1898 <!-- TYPE -->
1899 <div style="display:inline">
1900 (
1901 <span id="typeTemplate">
1902 <span>
1903 <span>object</span>
1904 </span>
1905 </span>
1906 )
1907 </div>
1908 </em>
1909 </dt>
1910 <dd class="todo">
1911 Undocumented.
1912 </dd>
1913 <!-- OBJECT PROPERTIES -->
1914 <dd>
1915 <dl>
1916 <div>
1917 <div>
1918 <dt>
1919 <var>type</var>
1920 <em>
1921 <!-- TYPE -->
1922 <div style="display:inline">
1923 (
1924 <span class="enum">enumerated</span>
1925 <span id="typeTemplate">
1926 <span>
1927 <span>string</span>
1928 <span>["keypress", "keydown", "keyup"]</span>
1929 </span>
1930 </span>
1931 )
1932 </div>
1933 </em>
1934 </dt>
1935 <dd class="todo">
1936 Undocumented.
1937 </dd>
1938 <!-- OBJECT PROPERTIES -->
1939 <!-- OBJECT METHODS -->
1940 <!-- OBJECT EVENT FIELDS -->
1941 <!-- FUNCTION PARAMETERS -->
1942 </div>
1943 </div><div>
1944 <div>
1945 <dt>
1946 <var>charCode</var>
1947 <em>
1948 <!-- TYPE -->
1949 <div style="display:inline">
1950 (
1951 <span id="typeTemplate">
1952 <span>
1953 <span>integer</span>
1954 </span>
1955 </span>
1956 )
1957 </div>
1958 </em>
1959 </dt>
1960 <dd class="todo">
1961 Undocumented.
1962 </dd>
1963 <!-- OBJECT PROPERTIES -->
1964 <!-- OBJECT METHODS -->
1965 <!-- OBJECT EVENT FIELDS -->
1966 <!-- FUNCTION PARAMETERS -->
1967 </div>
1968 </div><div>
1969 <div>
1970 <dt>
1971 <var>keyCode</var>
1972 <em>
1973 <!-- TYPE -->
1974 <div style="display:inline">
1975 (
1976 <span id="typeTemplate">
1977 <span>
1978 <span>integer</span>
1979 </span>
1980 </span>
1981 )
1982 </div>
1983 </em>
1984 </dt>
1985 <dd class="todo">
1986 Undocumented.
1987 </dd>
1988 <!-- OBJECT PROPERTIES -->
1989 <!-- OBJECT METHODS -->
1990 <!-- OBJECT EVENT FIELDS -->
1991 <!-- FUNCTION PARAMETERS -->
1992 </div>
1993 </div><div>
1994 <div>
1995 <dt>
1996 <var>altKey</var>
1997 <em>
1998 <!-- TYPE -->
1999 <div style="display:inline">
2000 (
2001 <span id="typeTemplate">
2002 <span>
2003 <span>boolean</span>
2004 </span>
2005 </span>
2006 )
2007 </div>
2008 </em>
2009 </dt>
2010 <dd class="todo">
2011 Undocumented.
2012 </dd>
2013 <!-- OBJECT PROPERTIES -->
2014 <!-- OBJECT METHODS -->
2015 <!-- OBJECT EVENT FIELDS -->
2016 <!-- FUNCTION PARAMETERS -->
2017 </div>
2018 </div><div>
2019 <div>
2020 <dt>
2021 <var>ctrlKey</var>
2022 <em>
2023 <!-- TYPE -->
2024 <div style="display:inline">
2025 (
2026 <span id="typeTemplate">
2027 <span>
2028 <span>boolean</span>
2029 </span>
2030 </span>
2031 )
2032 </div>
2033 </em>
2034 </dt>
2035 <dd class="todo">
2036 Undocumented.
2037 </dd>
2038 <!-- OBJECT PROPERTIES -->
2039 <!-- OBJECT METHODS -->
2040 <!-- OBJECT EVENT FIELDS -->
2041 <!-- FUNCTION PARAMETERS -->
2042 </div>
2043 </div><div>
2044 <div>
2045 <dt>
2046 <var>shiftKey</var>
2047 <em>
2048 <!-- TYPE -->
2049 <div style="display:inline">
2050 (
2051 <span id="typeTemplate">
2052 <span>
2053 <span>boolean</span>
2054 </span>
2055 </span>
2056 )
2057 </div>
2058 </em>
2059 </dt>
2060 <dd class="todo">
2061 Undocumented.
2062 </dd>
2063 <!-- OBJECT PROPERTIES -->
2064 <!-- OBJECT METHODS -->
2065 <!-- OBJECT EVENT FIELDS -->
2066 <!-- FUNCTION PARAMETERS -->
2067 </div>
2068 </div><div>
2069 <div>
2070 <dt>
2071 <var>metaKey</var>
2072 <em>
2073 <!-- TYPE -->
2074 <div style="display:inline">
2075 (
2076 <span class="optional">optional</span>
2077 <span id="typeTemplate">
2078 <span>
2079 <span>boolean</span>
2080 </span>
2081 </span>
2082 )
2083 </div>
2084 </em>
2085 </dt>
2086 <dd class="todo">
2087 Undocumented.
2088 </dd>
2089 <!-- OBJECT PROPERTIES -->
2090 <!-- OBJECT METHODS -->
2091 <!-- OBJECT EVENT FIELDS -->
2092 <!-- FUNCTION PARAMETERS -->
2093 </div>
2094 </div>
2095 </dl>
2096 </dd>
2097 <!-- OBJECT METHODS -->
2098 <!-- OBJECT EVENT FIELDS -->
2099 <!-- FUNCTION PARAMETERS -->
2100 </div>
2101 </div> <!-- /apiItem -->
2102 </div> <!-- /apiGroup -->
2103 </div> <!-- /apiPage -->
2104 </div> <!-- /gc-pagecontent -->
2105 </div> <!-- /g-section -->
2106 </div> <!-- /codesiteContent -->
2107 <div id="gc-footer" --="">
2108 <div class="text">
2109 <p>
2110 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
2111 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
2112 Attribution 3.0 License</a>, and code samples are licensed under the
2113 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
2114 </p>
2115 <p>
2116 ©2011 Google
2117 </p>
2118 <!-- begin analytics -->
2119 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
2120 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
2121 <script type="text/javascript">
2122 // chrome doc tracking
2123 try {
2124 var engdocs = _gat._getTracker("YT-10763712-2");
2125 engdocs._trackPageview();
2126 } catch(err) {}
2127 // code.google.com site-wide tracking
2128 try {
2129 _uacct="UA-18071-1";
2130 _uanchor=1;
2131 _uff=0;
2132 urchinTracker();
2133 }
2134 catch(e) {/* urchinTracker not available. */}
2135 </script>
2136 <!-- end analytics -->
2137 </div>
2138 </div> <!-- /gc-footer -->
2139 </div> <!-- /gc-container -->
2140 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698