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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.devtools.audits.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
« no previous file with comments | « chrome/common/extensions/docs/experimental.devtools.html ('k') | chrome/common/extensions/docs/experimental.devtools.console.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
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.de vtools.audits module, which is part of the Google Chrome extension APIs."><titl e>chrome.experimental.devtools.audits - Google Chrome Extensions - Google Code</ title></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.devtools.audits</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#H2-0">Overview</a>
196 <ol>
197 </ol>
198 </li><li>
199 <a href="#H2-1">Examples</a>
200 <ol>
201 </ol>
202 </li>
203 <li>
204 <a href="#apiReference">API reference: chrome.experimental.devto ols.audits</a>
205 <ol>
206 <li>
207 <a href="#global-methods">Methods</a>
208 <ol>
209 <li>
210 <a href="#method-addCategory">addCategory</a>
211 </li>
212 </ol>
213 </li>
214 <li>
215 <a href="#types">Types</a>
216 <ol>
217 <li>
218 <a href="#type-AuditCategory">AuditCategory</a>
219 <ol>
220 <li>
221 <a href="#global-AuditCategory-events">Events</a>
222 <ol>
223 <li>
224 <a href="#event-AuditCategory-onAuditStarted">onAuditStarted</a>
225 </li>
226 </ol>
227 </li>
228 </ol>
229 </li><li>
230 <a href="#type-FormattedValue">FormattedValue</a>
231 <ol>
232 </ol>
233 </li><li>
234 <a href="#type-AuditResults">AuditResults</a>
235 <ol>
236 <li>
237 <a href="#global-AuditResults-methods">Methods</a>
238 <ol>
239 <li>
240 <a href="#method-AuditResults-addResult">addResult</a>
241 </li><li>
242 <a href="#method-AuditResults-createResult">createResult</a>
243 </li><li>
244 <a href="#method-AuditResults-createSnippet">createSnippet</a>
245 </li><li>
246 <a href="#method-AuditResults-createURL">createURL</a>
247 </li><li>
248 <a href="#method-AuditResults-done">done</a>
249 </li>
250 </ol>
251 </li>
252 </ol>
253 </li><li>
254 <a href="#type-AuditResultNode">AuditResultNode</a>
255 <ol>
256 <li>
257 <a href="#global-AuditResultNode-methods">Methods</a>
258 <ol>
259 <li>
260 <a href="#method-AuditResultNode-addChild">addChild</a>
261 </li>
262 </ol>
263 </li>
264 </ol>
265 </li><li>
266 <a href="#type-AuditResultSeverity">AuditResultSeverity</a>
267 <ol>
268 </ol>
269 </li>
270 </ol>
271 </li>
272 </ol>
273 </li>
274 </ol>
275 </div>
276 <!-- /TABLE OF CONTENTS -->
277 <!-- Standard content lead-in for experimental API pages -->
278 <p id="classSummary">
279 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
280 </p>
281 <!-- STATIC CONTENT PLACEHOLDER -->
282 <div id="static"><!-- BEGIN AUTHORED CONTENT -->
283 <p id="classSummary">
284 Use the <code>chrome.experimental.devtools.audits</code> module to add new audit
285 categories to Developer Tools' Audit panel.
286 </p><p>
287 See <a href="experimental.devtools.html">DevTools APIs summary</a> for
288 general introduction to using Developer Tools APIs.
289 </p>
290 <a name="H2-0"></a><h2>Overview</h2>
291 <p>
292 Each audit category is represented by a line on <em>Select audits to run</em>
293 screen in the Audits panel. The following example adds a category named
294 <em>Readability</em>:</p>
295 <pre>var category = chrome.experimental.devtools.audits.addCategory("Readability ", 2);
296 </pre>
297 <img src="images/devtools-audits-category.png" style="margin-left: 20px" width=" 489" height="342" alt="Extension audit category on the launch screen of Audits p anel">
298 <p>
299 If the category's checkbox is checked, the <code>onAuditStarted</code> event of
300 that category will be fired when user clicks the <em>Run</em> button.
301 </p>
302 <p>The event handler in your extension receives <code>AuditResults</code>
303 as an argument and should add one or more results using <code>addResult()</code>
304 method. This may be done asynchronously, i.e. after the handler returns. The
305 run of the category is considered to be complete once the extension adds the
306 number of results declared when adding the category with
307 <code>addCategory()</code> or
308 calls AuditResult's <code>done()</code> method.
309 </p>
310 <p>The results may include additional details visualized as an expandable
311 tree by the Audits panel. You may build the details tree using the
312 <code>createResult()</code> and <code>addChild()</code> methods. The child node
313 may include specially formatted fragments created by the
314 <code>auditResults.createSnippet()</code>
315 and <code>auditResults.createURL()</code> methods.
316 </p>
317 <a name="H2-1"></a><h2>Examples</h2>
318 <p>The following example adds a handler for onAuditStarted event that creates
319 two audit results and populates one of them with the additional details:
320 </p>
321 <pre>category.onAuditStarted.addListener(function(results) {
322 var details = results.createResult("Details...");
323 var styles = details.addChild("2 styles with small font");
324 var elements = details.addChild("3 elements with small font");
325 results.addResult("Font Size (5)",
326 "5 elements use font size below 10pt",
327 results.Severity.Severe,
328 details);
329 results.addResult("Contrast",
330 "Text should stand out from background",
331 results.Severity.Info);
332 });
333 </pre>
334 <p>The audit result tree produced by the snippet above will look like this:
335 </p>
336 <img src="images/devtools-audits-results.png" style="margin-left: 20px" width="3 30" height="169" alt="Audit results example">
337 <p>
338 You can find more examples that use this API in
339 <a href="samples.html#devtools.audits">Samples</a>.
340 </p>
341 <!-- END AUTHORED CONTENT -->
342 </div>
343 <!-- API PAGE -->
344 <div class="apiPage">
345 <a name="apiReference"></a>
346 <h2>API reference: chrome.experimental.devtools.audits</h2>
347 <!-- PROPERTIES -->
348 <!-- /apiGroup -->
349 <!-- METHODS -->
350 <div id="methodsTemplate" class="apiGroup">
351 <a name="global-methods"></a>
352 <h3>Methods</h3>
353 <!-- iterates over all functions -->
354 <div class="apiItem">
355 <a name="method-addCategory"></a> <!-- method-anchor -->
356 <h4>addCategory</h4>
357 <div class="summary"><span>AuditCategory</span>
358 <!-- Note: intentionally longer 80 columns -->
359 <span>chrome.experimental.devtools.audits.addCategory</span>(< span class="null"><span>string</span>
360 <var><span>displayName</span></var></span><span class="nul l"><span>, </span><span>number</span>
361 <var><span>resultCount</span></var></span>)</div>
362 <div class="description">
363 <p>Adds an audit category.</p>
364 <!-- PARAMETERS -->
365 <h4>Parameters</h4>
366 <dl>
367 <div>
368 <div>
369 <dt>
370 <var>displayName</var>
371 <em>
372 <!-- TYPE -->
373 <div style="display:inline">
374 (
375 <span id="typeTemplate">
376 <span>
377 <span>string</span>
378 </span>
379 </span>
380 )
381 </div>
382 </em>
383 </dt>
384 <dd>A display name for the category.</dd>
385 <!-- OBJECT PROPERTIES -->
386 <!-- OBJECT METHODS -->
387 <!-- OBJECT EVENT FIELDS -->
388 <!-- FUNCTION PARAMETERS -->
389 </div>
390 </div><div>
391 <div>
392 <dt>
393 <var>resultCount</var>
394 <em>
395 <!-- TYPE -->
396 <div style="display:inline">
397 (
398 <span id="typeTemplate">
399 <span>
400 <span>number</span>
401 </span>
402 </span>
403 )
404 </div>
405 </em>
406 </dt>
407 <dd>The expected number of audit results in the category.</dd>
408 <!-- OBJECT PROPERTIES -->
409 <!-- OBJECT METHODS -->
410 <!-- OBJECT EVENT FIELDS -->
411 <!-- FUNCTION PARAMETERS -->
412 </div>
413 </div>
414 </dl>
415 <!-- RETURNS -->
416 <h4>Returns</h4>
417 <dl>
418 <div>
419 <div>
420 <dt>
421 <em>
422 <!-- TYPE -->
423 <div style="display:inline">
424 (
425 <span id="typeTemplate">
426 <span>
427 <a href="experimental.devtools.audits.html#type-AuditCat egory">AuditCategory</a>
428 </span>
429 </span>
430 )
431 </div>
432 </em>
433 </dt>
434 <dd class="todo">
435 Undocumented.
436 </dd>
437 <!-- OBJECT PROPERTIES -->
438 <!-- OBJECT METHODS -->
439 <!-- OBJECT EVENT FIELDS -->
440 <!-- FUNCTION PARAMETERS -->
441 </div>
442 </div>
443 </dl>
444 <!-- CALLBACK -->
445 <!-- MIN_VERSION -->
446 </div> <!-- /description -->
447 </div> <!-- /apiItem -->
448 </div> <!-- /apiGroup -->
449 <!-- EVENTS -->
450 <!-- /apiGroup -->
451 <!-- TYPES -->
452 <div class="apiGroup">
453 <a name="types"></a>
454 <h3 id="types">Types</h3>
455 <!-- iterates over all types -->
456 <div class="apiItem">
457 <a name="type-AuditCategory"></a>
458 <h4>AuditCategory</h4>
459 <div>
460 <dt>
461 <em>
462 <!-- TYPE -->
463 <div style="display:inline">
464 (
465 <span id="typeTemplate">
466 <span>
467 <span>object</span>
468 </span>
469 </span>
470 )
471 </div>
472 </em>
473 </dt>
474 <dd>A group of logically related audit checks.</dd>
475 <!-- OBJECT PROPERTIES -->
476 <!-- OBJECT METHODS -->
477 <!-- OBJECT EVENT FIELDS -->
478 <dd>
479 <div class="apiGroup">
480 <a name="global-AuditCategory-events"></a>
481 <h3>Events of AuditCategory</h3>
482 <!-- iterates over all events -->
483 <div class="apiItem">
484 <a name="event-AuditCategory-onAuditStarted"></a>
485 <h4>onAuditStarted</h4>
486 <div class="summary">
487 <!-- Note: intentionally longer 80 columns -->
488 <span class="subdued">auditCategory.</span><span>onAuditStarted< /span><span class="subdued">.addListener</span>(function(<span>AuditResults resu lts</span>) <span class="subdued">{...}</span><span></span>);
489 </div>
490 <div class="description">
491 <p>If the category is enabled, this event is fired when the audi t is started. The event handler is expected to initiate execution of the audit l ogic that will populate the <code>results</code> collection.</p>
492 <!-- LISTENER PARAMETERS -->
493 <div>
494 <h4>Listener parameters</h4>
495 <dl>
496 <div>
497 <div>
498 <dt>
499 <var>results</var>
500 <em>
501 <!-- TYPE -->
502 <div style="display:inline">
503 (
504 <span id="typeTemplate">
505 <span>
506 <a href="experimental.devtools.audits.html#type-AuditRes ults">AuditResults</a>
507 </span>
508 </span>
509 )
510 </div>
511 </em>
512 </dt>
513 <dd class="todo">
514 Undocumented.
515 </dd>
516 <!-- OBJECT PROPERTIES -->
517 <!-- OBJECT METHODS -->
518 <!-- OBJECT EVENT FIELDS -->
519 <!-- FUNCTION PARAMETERS -->
520 </div>
521 </div>
522 </dl>
523 </div>
524 <!-- EXTRA PARAMETERS -->
525 <!-- LISTENER RETURN VALUE -->
526 <dl>
527 </dl>
528 </div> <!-- /description -->
529 <!-- /description -->
530 </div> <!-- /apiItem -->
531 </div>
532 </dd>
533 <!-- FUNCTION PARAMETERS -->
534 </div>
535 </div><div class="apiItem">
536 <a name="type-FormattedValue"></a>
537 <h4>FormattedValue</h4>
538 <div>
539 <dt>
540 <em>
541 <!-- TYPE -->
542 <div style="display:inline">
543 (
544 <span id="typeTemplate">
545 <span>
546 <span>object</span>
547 </span>
548 </span>
549 )
550 </div>
551 </em>
552 </dt>
553 <dd>A value returned from one of the formatters (a URL, code snippet e tc), to be passed to <code>createResult()</code> or <code>addChild()</code>. See <a href="#method-AuditResults-createSnippet"><code>createSnippet()</code></a> a nd <a href="#method-AuditResults-createURL"><code>createURL()</code></a>.</dd>
554 <!-- OBJECT PROPERTIES -->
555 <!-- OBJECT METHODS -->
556 <!-- OBJECT EVENT FIELDS -->
557 <!-- FUNCTION PARAMETERS -->
558 </div>
559 </div><div class="apiItem">
560 <a name="type-AuditResults"></a>
561 <h4>AuditResults</h4>
562 <div>
563 <dt>
564 <em>
565 <!-- TYPE -->
566 <div style="display:inline">
567 (
568 <span id="typeTemplate">
569 <span>
570 <span>object</span>
571 </span>
572 </span>
573 )
574 </div>
575 </em>
576 </dt>
577 <dd>A collection of audit results for the current run of the audit cat egory.</dd>
578 <!-- OBJECT PROPERTIES -->
579 <dd>
580 <dl>
581 <div>
582 <div>
583 <dt>
584 <var>Severity</var>
585 <em>
586 <!-- TYPE -->
587 <div style="display:inline">
588 (
589 <span id="typeTemplate">
590 <span>
591 <a href="experimental.devtools.audits.html#type-AuditRes ultSeverity">AuditResultSeverity</a>
592 </span>
593 </span>
594 )
595 </div>
596 </em>
597 </dt>
598 <dd>A class that contains possible values for the audit result severit ies.</dd>
599 <!-- OBJECT PROPERTIES -->
600 <!-- OBJECT METHODS -->
601 <!-- OBJECT EVENT FIELDS -->
602 <!-- FUNCTION PARAMETERS -->
603 </div>
604 </div><div>
605 <div>
606 <dt>
607 <var>text</var>
608 <em>
609 <!-- TYPE -->
610 <div style="display:inline">
611 (
612 <span id="typeTemplate">
613 <span>
614 <span>string</span>
615 </span>
616 </span>
617 )
618 </div>
619 </em>
620 </dt>
621 <dd>The contents of the node.</dd>
622 <!-- OBJECT PROPERTIES -->
623 <!-- OBJECT METHODS -->
624 <!-- OBJECT EVENT FIELDS -->
625 <!-- FUNCTION PARAMETERS -->
626 </div>
627 </div><div>
628 <div>
629 <dt>
630 <var>children</var>
631 <em>
632 <!-- TYPE -->
633 <div style="display:inline">
634 (
635 <span class="optional">optional</span>
636 <span id="typeTemplate">
637 <span>
638 <span>
639 array of <span><span>
640 <span>
641 <a href="experimental.devtools.audits.html#type-AuditRes ultNode">AuditResultNode</a>
642 </span>
643 </span></span>
644 </span>
645 </span>
646 </span>
647 )
648 </div>
649 </em>
650 </dt>
651 <dd>Children of this node.</dd>
652 <!-- OBJECT PROPERTIES -->
653 <!-- OBJECT METHODS -->
654 <!-- OBJECT EVENT FIELDS -->
655 <!-- FUNCTION PARAMETERS -->
656 </div>
657 </div><div>
658 <div>
659 <dt>
660 <var>expanded</var>
661 <em>
662 <!-- TYPE -->
663 <div style="display:inline">
664 (
665 <span class="optional">optional</span>
666 <span id="typeTemplate">
667 <span>
668 <span>boolean</span>
669 </span>
670 </span>
671 )
672 </div>
673 </em>
674 </dt>
675 <dd>Whether the node is expanded by default.</dd>
676 <!-- OBJECT PROPERTIES -->
677 <!-- OBJECT METHODS -->
678 <!-- OBJECT EVENT FIELDS -->
679 <!-- FUNCTION PARAMETERS -->
680 </div>
681 </div>
682 </dl>
683 </dd>
684 <!-- OBJECT METHODS -->
685 <dd>
686 <div class="apiGroup">
687 <a name="global-AuditResults-methods"></a>
688 <h3>Methods of AuditResults</h3>
689 <!-- iterates over all functions -->
690 <div class="apiItem">
691 <a name="method-AuditResults-addResult"></a> <!-- method-anchor -- >
692 <h4>addResult</h4>
693 <div class="summary">
694 <!-- Note: intentionally longer 80 columns -->
695 <span>auditResults.addResult</span>(<span class="null"><span>s tring</span>
696 <var><span>displayName</span></var></span><span class="nul l"><span>, </span><span>string</span>
697 <var><span>description</span></var></span><span class="nul l"><span>, </span><span>AuditResultSeverity</span>
698 <var><span>severity</span></var></span><span class="option al"><span>, </span><span>AuditResultNode</span>
699 <var><span>details</span></var></span>)</div>
700 <div class="description">
701 <p>Adds an audit result. The results are rendered as bulleted it ems under the audit category assoicated with the <code>AuditResults</code> objec t.</p>
702 <!-- PARAMETERS -->
703 <h4>Parameters</h4>
704 <dl>
705 <div>
706 <div>
707 <dt>
708 <var>displayName</var>
709 <em>
710 <!-- TYPE -->
711 <div style="display:inline">
712 (
713 <span id="typeTemplate">
714 <span>
715 <span>string</span>
716 </span>
717 </span>
718 )
719 </div>
720 </em>
721 </dt>
722 <dd>A concise, high-level description of the result.</dd>
723 <!-- OBJECT PROPERTIES -->
724 <!-- OBJECT METHODS -->
725 <!-- OBJECT EVENT FIELDS -->
726 <!-- FUNCTION PARAMETERS -->
727 </div>
728 </div><div>
729 <div>
730 <dt>
731 <var>description</var>
732 <em>
733 <!-- TYPE -->
734 <div style="display:inline">
735 (
736 <span id="typeTemplate">
737 <span>
738 <span>string</span>
739 </span>
740 </span>
741 )
742 </div>
743 </em>
744 </dt>
745 <dd>A detailed description of what the displayName means.</dd>
746 <!-- OBJECT PROPERTIES -->
747 <!-- OBJECT METHODS -->
748 <!-- OBJECT EVENT FIELDS -->
749 <!-- FUNCTION PARAMETERS -->
750 </div>
751 </div><div>
752 <div>
753 <dt>
754 <var>severity</var>
755 <em>
756 <!-- TYPE -->
757 <div style="display:inline">
758 (
759 <span id="typeTemplate">
760 <span>
761 <a href="experimental.devtools.audits.html#type-AuditRes ultSeverity">AuditResultSeverity</a>
762 </span>
763 </span>
764 )
765 </div>
766 </em>
767 </dt>
768 <dd class="todo">
769 Undocumented.
770 </dd>
771 <!-- OBJECT PROPERTIES -->
772 <!-- OBJECT METHODS -->
773 <!-- OBJECT EVENT FIELDS -->
774 <!-- FUNCTION PARAMETERS -->
775 </div>
776 </div><div>
777 <div>
778 <dt>
779 <var>details</var>
780 <em>
781 <!-- TYPE -->
782 <div style="display:inline">
783 (
784 <span class="optional">optional</span>
785 <span id="typeTemplate">
786 <span>
787 <a href="experimental.devtools.audits.html#type-AuditRes ultNode">AuditResultNode</a>
788 </span>
789 </span>
790 )
791 </div>
792 </em>
793 </dt>
794 <dd>A subtree that appears under the added result that may provide add itional details on the violations found.</dd>
795 <!-- OBJECT PROPERTIES -->
796 <!-- OBJECT METHODS -->
797 <!-- OBJECT EVENT FIELDS -->
798 <!-- FUNCTION PARAMETERS -->
799 </div>
800 </div>
801 </dl>
802 <!-- RETURNS -->
803 <dl>
804 </dl>
805 <!-- CALLBACK -->
806 <!-- MIN_VERSION -->
807 </div> <!-- /description -->
808 </div><div class="apiItem">
809 <a name="method-AuditResults-createResult"></a> <!-- method-anchor -->
810 <h4>createResult</h4>
811 <div class="summary"><span>AuditResultNode</span>
812 <!-- Note: intentionally longer 80 columns -->
813 <span>auditResults.createResult</span>(<span class="null"><spa n>string or FormattedValue</span>
814 <var><span>content ...</span></var></span>)</div>
815 <div class="description">
816 <p>Creates a result node that may be used as the <code>details</ code> parameters to the <code>addResult()</code> method.</p>
817 <!-- PARAMETERS -->
818 <h4>Parameters</h4>
819 <dl>
820 <div>
821 <div>
822 <dt>
823 <var>content ...</var>
824 <em>
825 <!-- TYPE -->
826 <div style="display:inline">
827 (
828 <span id="typeTemplate">
829 <span>
830 <span>string or FormattedValue</span>
831 </span>
832 </span>
833 )
834 </div>
835 </em>
836 </dt>
837 <dd>Either string or formatted values returned by one of the AuditResu lt formatters (a URL, a snippet etc). If multiple arguments are passed, these wi ll be concatenated into a single node.</dd>
838 <!-- OBJECT PROPERTIES -->
839 <!-- OBJECT METHODS -->
840 <!-- OBJECT EVENT FIELDS -->
841 <!-- FUNCTION PARAMETERS -->
842 </div>
843 </div>
844 </dl>
845 <!-- RETURNS -->
846 <h4>Returns</h4>
847 <dl>
848 <div>
849 <div>
850 <dt>
851 <em>
852 <!-- TYPE -->
853 <div style="display:inline">
854 (
855 <span id="typeTemplate">
856 <span>
857 <a href="experimental.devtools.audits.html#type-AuditRes ultNode">AuditResultNode</a>
858 </span>
859 </span>
860 )
861 </div>
862 </em>
863 </dt>
864 <dd class="todo">
865 Undocumented.
866 </dd>
867 <!-- OBJECT PROPERTIES -->
868 <!-- OBJECT METHODS -->
869 <!-- OBJECT EVENT FIELDS -->
870 <!-- FUNCTION PARAMETERS -->
871 </div>
872 </div>
873 </dl>
874 <!-- CALLBACK -->
875 <!-- MIN_VERSION -->
876 </div> <!-- /description -->
877 </div><div class="apiItem">
878 <a name="method-AuditResults-createSnippet"></a> <!-- method-ancho r -->
879 <h4>createSnippet</h4>
880 <div class="summary"><span>FormattedValue</span>
881 <!-- Note: intentionally longer 80 columns -->
882 <span>auditResults.createSnippet</span>(<span class="null"><sp an>string</span>
883 <var><span>text</span></var></span>)</div>
884 <div class="description">
885 <p>Render passed text as a code snippet in the Audits panel.</p>
886 <!-- PARAMETERS -->
887 <h4>Parameters</h4>
888 <dl>
889 <div>
890 <div>
891 <dt>
892 <var>text</var>
893 <em>
894 <!-- TYPE -->
895 <div style="display:inline">
896 (
897 <span id="typeTemplate">
898 <span>
899 <span>string</span>
900 </span>
901 </span>
902 )
903 </div>
904 </em>
905 </dt>
906 <dd>Snippet text.</dd>
907 <!-- OBJECT PROPERTIES -->
908 <!-- OBJECT METHODS -->
909 <!-- OBJECT EVENT FIELDS -->
910 <!-- FUNCTION PARAMETERS -->
911 </div>
912 </div>
913 </dl>
914 <!-- RETURNS -->
915 <h4>Returns</h4>
916 <dl>
917 <div>
918 <div>
919 <dt>
920 <em>
921 <!-- TYPE -->
922 <div style="display:inline">
923 (
924 <span id="typeTemplate">
925 <span>
926 <a href="experimental.devtools.audits.html#type-Formatte dValue">FormattedValue</a>
927 </span>
928 </span>
929 )
930 </div>
931 </em>
932 </dt>
933 <dd class="todo">
934 Undocumented.
935 </dd>
936 <!-- OBJECT PROPERTIES -->
937 <!-- OBJECT METHODS -->
938 <!-- OBJECT EVENT FIELDS -->
939 <!-- FUNCTION PARAMETERS -->
940 </div>
941 </div>
942 </dl>
943 <!-- CALLBACK -->
944 <!-- MIN_VERSION -->
945 </div> <!-- /description -->
946 </div><div class="apiItem">
947 <a name="method-AuditResults-createURL"></a> <!-- method-anchor -- >
948 <h4>createURL</h4>
949 <div class="summary"><span>FormattedValue</span>
950 <!-- Note: intentionally longer 80 columns -->
951 <span>auditResults.createURL</span>(<span class="null"><span>s tring</span>
952 <var><span>href</span></var></span><span class="optional"> <span>, </span><span>string</span>
953 <var><span>displayText</span></var></span>)</div>
954 <div class="description">
955 <p>Render passed value as a URL in the Audits panel.</p>
956 <!-- PARAMETERS -->
957 <h4>Parameters</h4>
958 <dl>
959 <div>
960 <div>
961 <dt>
962 <var>href</var>
963 <em>
964 <!-- TYPE -->
965 <div style="display:inline">
966 (
967 <span id="typeTemplate">
968 <span>
969 <span>string</span>
970 </span>
971 </span>
972 )
973 </div>
974 </em>
975 </dt>
976 <dd>A URL that appears as the href value on the resulting link.</dd>
977 <!-- OBJECT PROPERTIES -->
978 <!-- OBJECT METHODS -->
979 <!-- OBJECT EVENT FIELDS -->
980 <!-- FUNCTION PARAMETERS -->
981 </div>
982 </div><div>
983 <div>
984 <dt>
985 <var>displayText</var>
986 <em>
987 <!-- TYPE -->
988 <div style="display:inline">
989 (
990 <span class="optional">optional</span>
991 <span id="typeTemplate">
992 <span>
993 <span>string</span>
994 </span>
995 </span>
996 )
997 </div>
998 </em>
999 </dt>
1000 <dd>Text that appears to the user.</dd>
1001 <!-- OBJECT PROPERTIES -->
1002 <!-- OBJECT METHODS -->
1003 <!-- OBJECT EVENT FIELDS -->
1004 <!-- FUNCTION PARAMETERS -->
1005 </div>
1006 </div>
1007 </dl>
1008 <!-- RETURNS -->
1009 <h4>Returns</h4>
1010 <dl>
1011 <div>
1012 <div>
1013 <dt>
1014 <em>
1015 <!-- TYPE -->
1016 <div style="display:inline">
1017 (
1018 <span id="typeTemplate">
1019 <span>
1020 <a href="experimental.devtools.audits.html#type-Formatte dValue">FormattedValue</a>
1021 </span>
1022 </span>
1023 )
1024 </div>
1025 </em>
1026 </dt>
1027 <dd class="todo">
1028 Undocumented.
1029 </dd>
1030 <!-- OBJECT PROPERTIES -->
1031 <!-- OBJECT METHODS -->
1032 <!-- OBJECT EVENT FIELDS -->
1033 <!-- FUNCTION PARAMETERS -->
1034 </div>
1035 </div>
1036 </dl>
1037 <!-- CALLBACK -->
1038 <!-- MIN_VERSION -->
1039 </div> <!-- /description -->
1040 </div><div class="apiItem">
1041 <a name="method-AuditResults-done"></a> <!-- method-anchor -->
1042 <h4>done</h4>
1043 <div class="summary">
1044 <!-- Note: intentionally longer 80 columns -->
1045 <span>auditResults.done</span>()</div>
1046 <div class="description">
1047 <p>Signals the DevTools Audits panel that the run of this catego ry is over. The audit run also completes automatically when the number of added top-level results is equal to that declared when AuditCategory was created.</p>
1048 <!-- PARAMETERS -->
1049 <dl>
1050 </dl>
1051 <!-- RETURNS -->
1052 <dl>
1053 </dl>
1054 <!-- CALLBACK -->
1055 <!-- MIN_VERSION -->
1056 </div> <!-- /description -->
1057 </div> <!-- /apiItem -->
1058 </div>
1059 </dd>
1060 <!-- OBJECT EVENT FIELDS -->
1061 <!-- FUNCTION PARAMETERS -->
1062 </div>
1063 </div><div class="apiItem">
1064 <a name="type-AuditResultNode"></a>
1065 <h4>AuditResultNode</h4>
1066 <div>
1067 <dt>
1068 <em>
1069 <!-- TYPE -->
1070 <div style="display:inline">
1071 (
1072 <span id="typeTemplate">
1073 <span>
1074 <span>object</span>
1075 </span>
1076 </span>
1077 )
1078 </div>
1079 </em>
1080 </dt>
1081 <dd>A node in the audit result tree. Displays content and may optional ly have children nodes.</dd>
1082 <!-- OBJECT PROPERTIES -->
1083 <dd>
1084 <dl>
1085 <div>
1086 <div>
1087 <dt>
1088 <var>expanded</var>
1089 <em>
1090 <!-- TYPE -->
1091 <div style="display:inline">
1092 (
1093 <span id="typeTemplate">
1094 <span>
1095 <span>boolean</span>
1096 </span>
1097 </span>
1098 )
1099 </div>
1100 </em>
1101 </dt>
1102 <dd>If set, the subtree will always be expanded.</dd>
1103 <!-- OBJECT PROPERTIES -->
1104 <!-- OBJECT METHODS -->
1105 <!-- OBJECT EVENT FIELDS -->
1106 <!-- FUNCTION PARAMETERS -->
1107 </div>
1108 </div>
1109 </dl>
1110 </dd>
1111 <!-- OBJECT METHODS -->
1112 <dd>
1113 <div class="apiGroup">
1114 <a name="global-AuditResultNode-methods"></a>
1115 <h3>Methods of AuditResultNode</h3>
1116 <!-- iterates over all functions -->
1117 <div class="apiItem">
1118 <a name="method-AuditResultNode-addChild"></a> <!-- method-anchor -->
1119 <h4>addChild</h4>
1120 <div class="summary"><span>AuditResultNode</span>
1121 <!-- Note: intentionally longer 80 columns -->
1122 <span>auditResultNode.addChild</span>(<span class="null"><span >string or FormattedValue</span>
1123 <var><span>content ...</span></var></span>)</div>
1124 <div class="description">
1125 <p>Adds a child node to this node.</p>
1126 <!-- PARAMETERS -->
1127 <h4>Parameters</h4>
1128 <dl>
1129 <div>
1130 <div>
1131 <dt>
1132 <var>content ...</var>
1133 <em>
1134 <!-- TYPE -->
1135 <div style="display:inline">
1136 (
1137 <span id="typeTemplate">
1138 <span>
1139 <span>string or FormattedValue</span>
1140 </span>
1141 </span>
1142 )
1143 </div>
1144 </em>
1145 </dt>
1146 <dd>Either string or formatted values returned by one of the AuditResu lt formatters (URL, snippet etc). If multiple arguments are passed, these will b e concatenated into a single node.</dd>
1147 <!-- OBJECT PROPERTIES -->
1148 <!-- OBJECT METHODS -->
1149 <!-- OBJECT EVENT FIELDS -->
1150 <!-- FUNCTION PARAMETERS -->
1151 </div>
1152 </div>
1153 </dl>
1154 <!-- RETURNS -->
1155 <h4>Returns</h4>
1156 <dl>
1157 <div>
1158 <div>
1159 <dt>
1160 <em>
1161 <!-- TYPE -->
1162 <div style="display:inline">
1163 (
1164 <span id="typeTemplate">
1165 <span>
1166 <a href="experimental.devtools.audits.html#type-AuditRes ultNode">AuditResultNode</a>
1167 </span>
1168 </span>
1169 )
1170 </div>
1171 </em>
1172 </dt>
1173 <dd class="todo">
1174 Undocumented.
1175 </dd>
1176 <!-- OBJECT PROPERTIES -->
1177 <!-- OBJECT METHODS -->
1178 <!-- OBJECT EVENT FIELDS -->
1179 <!-- FUNCTION PARAMETERS -->
1180 </div>
1181 </div>
1182 </dl>
1183 <!-- CALLBACK -->
1184 <!-- MIN_VERSION -->
1185 </div> <!-- /description -->
1186 </div> <!-- /apiItem -->
1187 </div>
1188 </dd>
1189 <!-- OBJECT EVENT FIELDS -->
1190 <!-- FUNCTION PARAMETERS -->
1191 </div>
1192 </div><div class="apiItem">
1193 <a name="type-AuditResultSeverity"></a>
1194 <h4>AuditResultSeverity</h4>
1195 <div>
1196 <dt>
1197 <em>
1198 <!-- TYPE -->
1199 <div style="display:inline">
1200 (
1201 <span id="typeTemplate">
1202 <span>
1203 <span>object</span>
1204 </span>
1205 </span>
1206 )
1207 </div>
1208 </em>
1209 </dt>
1210 <dd>This type contains possible values for a result severity. The resu lts of different severities are distinguished by colored bullets near the result 's display name.</dd>
1211 <!-- OBJECT PROPERTIES -->
1212 <dd>
1213 <dl>
1214 <div>
1215 <div>
1216 <dt>
1217 <var>Info</var>
1218 <em>
1219 <!-- TYPE -->
1220 <div style="display:inline">
1221 (
1222 <span id="typeTemplate">
1223 <span>
1224 <span>string</span>
1225 </span>
1226 </span>
1227 )
1228 </div>
1229 </em>
1230 </dt>
1231 <dd class="todo">
1232 Undocumented.
1233 </dd>
1234 <!-- OBJECT PROPERTIES -->
1235 <!-- OBJECT METHODS -->
1236 <!-- OBJECT EVENT FIELDS -->
1237 <!-- FUNCTION PARAMETERS -->
1238 </div>
1239 </div><div>
1240 <div>
1241 <dt>
1242 <var>Warning</var>
1243 <em>
1244 <!-- TYPE -->
1245 <div style="display:inline">
1246 (
1247 <span id="typeTemplate">
1248 <span>
1249 <span>string</span>
1250 </span>
1251 </span>
1252 )
1253 </div>
1254 </em>
1255 </dt>
1256 <dd class="todo">
1257 Undocumented.
1258 </dd>
1259 <!-- OBJECT PROPERTIES -->
1260 <!-- OBJECT METHODS -->
1261 <!-- OBJECT EVENT FIELDS -->
1262 <!-- FUNCTION PARAMETERS -->
1263 </div>
1264 </div><div>
1265 <div>
1266 <dt>
1267 <var>Severe</var>
1268 <em>
1269 <!-- TYPE -->
1270 <div style="display:inline">
1271 (
1272 <span id="typeTemplate">
1273 <span>
1274 <span>string</span>
1275 </span>
1276 </span>
1277 )
1278 </div>
1279 </em>
1280 </dt>
1281 <dd class="todo">
1282 Undocumented.
1283 </dd>
1284 <!-- OBJECT PROPERTIES -->
1285 <!-- OBJECT METHODS -->
1286 <!-- OBJECT EVENT FIELDS -->
1287 <!-- FUNCTION PARAMETERS -->
1288 </div>
1289 </div>
1290 </dl>
1291 </dd>
1292 <!-- OBJECT METHODS -->
1293 <!-- OBJECT EVENT FIELDS -->
1294 <!-- FUNCTION PARAMETERS -->
1295 </div>
1296 </div> <!-- /apiItem -->
1297 </div> <!-- /apiGroup -->
1298 </div> <!-- /apiPage -->
1299 </div> <!-- /gc-pagecontent -->
1300 </div> <!-- /g-section -->
1301 </div> <!-- /codesiteContent -->
1302 <div id="gc-footer" --="">
1303 <div class="text">
1304 <p>
1305 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1306 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1307 Attribution 3.0 License</a>, and code samples are licensed under the
1308 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1309 </p>
1310 <p>
1311 ©2011 Google
1312 </p>
1313 <!-- begin analytics -->
1314 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
1315 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
1316 <script type="text/javascript">
1317 // chrome doc tracking
1318 try {
1319 var engdocs = _gat._getTracker("YT-10763712-2");
1320 engdocs._trackPageview();
1321 } catch(err) {}
1322 // code.google.com site-wide tracking
1323 try {
1324 _uacct="UA-18071-1";
1325 _uanchor=1;
1326 _uff=0;
1327 urchinTracker();
1328 }
1329 catch(e) {/* urchinTracker not available. */}
1330 </script>
1331 <!-- end analytics -->
1332 </div>
1333 </div> <!-- /gc-footer -->
1334 </div> <!-- /gc-container -->
1335 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.devtools.html ('k') | chrome/common/extensions/docs/experimental.devtools.console.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698