sdk/platform-tools/systrace/catapult/telemetry/docs/pydoc/telemetry.web_perf.metrics.layout.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module telemetry.web_perf.metrics.layout</title>
   4 <meta charset="utf-8">
   5 </head><body bgcolor="#f0f0f8">
   6
   7 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
   8 <tr bgcolor="#7799ee">
   9 <td valign=bottom>&nbsp;<br>
  10 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.web_perf.html"><font color="#ffffff">web_perf</font></a>.<a href="telemetry.web_perf.metrics.html"><font color="#ffffff">metrics</font></a>.layout</strong></big></big></font></td
  11 ><td align=right valign=bottom
  12 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/web_perf/metrics/layout.py">telemetry/web_perf/metrics/layout.py</a></font></td></tr></table>
  13     <p><tt>#&nbsp;Copyright&nbsp;2014&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
  14 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
  15 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
  16 <p>
  17 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  18 <tr bgcolor="#aa55cc">
  19 <td colspan=3 valign=bottom>&nbsp;<br>
  20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  21
  22 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.web_perf.metrics.single_event.html">telemetry.web_perf.metrics.single_event</a><br>
  24 </td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
  25 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  26 <tr bgcolor="#ee77aa">
  27 <td colspan=3 valign=bottom>&nbsp;<br>
  28 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  29
  30 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  31 <td width="100%"><dl>
  32 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.metrics.single_event.html#_SingleEventMetric">telemetry.web_perf.metrics.single_event._SingleEventMetric</a>(<a href="telemetry.web_perf.metrics.timeline_based_metric.html#TimelineBasedMetric">telemetry.web_perf.metrics.timeline_based_metric.TimelineBasedMetric</a>)
  33 </font></dt><dd>
  34 <dl>
  35 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.metrics.layout.html#LayoutMetric">LayoutMetric</a>
  36 </font></dt></dl>
  37 </dd>
  38 </dl>
  39  <p>
  40 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  41 <tr bgcolor="#ffc8d8">
  42 <td colspan=3 valign=bottom>&nbsp;<br>
  43 <font color="#000000" face="helvetica, arial"><a name="LayoutMetric">class <strong>LayoutMetric</strong></a>(<a href="telemetry.web_perf.metrics.single_event.html#_SingleEventMetric">telemetry.web_perf.metrics.single_event._SingleEventMetric</a>)</font></td></tr>
  44
  45 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  46 <td colspan=2><tt>Reports&nbsp;directly&nbsp;durations&nbsp;of&nbsp;FrameView::performLayout&nbsp;events.<br>
  47 &nbsp;<br>
  48 &nbsp;&nbsp;layout:&nbsp;Durations&nbsp;of&nbsp;FrameView::performLayout&nbsp;events&nbsp;that&nbsp;were&nbsp;caused&nbsp;by&nbsp;and<br>
  49 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;start&nbsp;during&nbsp;user&nbsp;interaction.<br>
  50 &nbsp;<br>
  51 Layout&nbsp;happens&nbsp;no&nbsp;more&nbsp;than&nbsp;once&nbsp;per&nbsp;frame,&nbsp;so&nbsp;per-frame-ness&nbsp;is&nbsp;implied.<br>&nbsp;</tt></td></tr>
  52 <tr><td>&nbsp;</td>
  53 <td width="100%"><dl><dt>Method resolution order:</dt>
  54 <dd><a href="telemetry.web_perf.metrics.layout.html#LayoutMetric">LayoutMetric</a></dd>
  55 <dd><a href="telemetry.web_perf.metrics.single_event.html#_SingleEventMetric">telemetry.web_perf.metrics.single_event._SingleEventMetric</a></dd>
  56 <dd><a href="telemetry.web_perf.metrics.timeline_based_metric.html#TimelineBasedMetric">telemetry.web_perf.metrics.timeline_based_metric.TimelineBasedMetric</a></dd>
  57 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  58 </dl>
  59 <hr>
  60 Methods defined here:<br>
  61 <dl><dt><a name="LayoutMetric-__init__"><strong>__init__</strong></a>(self)</dt></dl>
  62
  63 <hr>
  64 Methods inherited from <a href="telemetry.web_perf.metrics.single_event.html#_SingleEventMetric">telemetry.web_perf.metrics.single_event._SingleEventMetric</a>:<br>
  65 <dl><dt><a name="LayoutMetric-AddResults"><strong>AddResults</strong></a>(self, _model, renderer_thread, interactions, results)</dt></dl>
  66
  67 <hr>
  68 Methods inherited from <a href="telemetry.web_perf.metrics.timeline_based_metric.html#TimelineBasedMetric">telemetry.web_perf.metrics.timeline_based_metric.TimelineBasedMetric</a>:<br>
  69 <dl><dt><a name="LayoutMetric-AddWholeTraceResults"><strong>AddWholeTraceResults</strong></a>(self, model, results)</dt><dd><tt>Computes&nbsp;and&nbsp;adds&nbsp;metrics&nbsp;corresponding&nbsp;to&nbsp;the&nbsp;entire&nbsp;trace.<br>
  70 &nbsp;<br>
  71 Override&nbsp;this&nbsp;method&nbsp;to&nbsp;compute&nbsp;results&nbsp;that&nbsp;correspond&nbsp;to&nbsp;the&nbsp;whole&nbsp;trace.<br>
  72 &nbsp;<br>
  73 Args:<br>
  74 &nbsp;&nbsp;model:&nbsp;An&nbsp;instance&nbsp;of&nbsp;telemetry.timeline.model.TimelineModel.<br>
  75 &nbsp;&nbsp;results:&nbsp;An&nbsp;instance&nbsp;of&nbsp;page.PageTestResults.</tt></dd></dl>
  76
  77 <dl><dt><a name="LayoutMetric-VerifyNonOverlappedRecords"><strong>VerifyNonOverlappedRecords</strong></a>(self, interaction_records)</dt><dd><tt>This&nbsp;raises&nbsp;exceptions&nbsp;if&nbsp;interaction_records&nbsp;contain&nbsp;overlapped&nbsp;ranges.</tt></dd></dl>
  78
  79 <hr>
  80 Data descriptors inherited from <a href="telemetry.web_perf.metrics.timeline_based_metric.html#TimelineBasedMetric">telemetry.web_perf.metrics.timeline_based_metric.TimelineBasedMetric</a>:<br>
  81 <dl><dt><strong>__dict__</strong></dt>
  82 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  83 </dl>
  84 <dl><dt><strong>__weakref__</strong></dt>
  85 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  86 </dl>
  87 </td></tr></table></td></tr></table><p>
  88 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  89 <tr bgcolor="#55aa55">
  90 <td colspan=3 valign=bottom>&nbsp;<br>
  91 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
  92
  93 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  94 <td width="100%"><strong>EVENT_NAME</strong> = 'FrameView::performLayout'<br>
  95 <strong>METRIC_NAME</strong> = 'layout'</td></tr></table>
  96 </body></html>