mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-15 05:53:13 +00:00
1224 lines
70 KiB
HTML
1224 lines
70 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
|
<title>API: profiler YAHOO.tool.Profiler (YUI Library)</title>
|
|
|
|
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css" />
|
|
|
|
<script type="text/javascript" src="assets/api-js"></script>
|
|
<script type="text/javascript" src="assets/ac-js"></script>
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
|
|
<div id="doc3" class="yui-t2">
|
|
<div id="hd">
|
|
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
|
|
<h3>profiler <span class="subtitle">2.8.2r1</span></h3>
|
|
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
|
|
> <a href="./module_profiler.html" title="profiler">profiler</a>
|
|
> YAHOO.tool.Profiler
|
|
|
|
<form onsubmit="return false">
|
|
<div id="propertysearch">
|
|
Search: <input autocomplete="off" id="searchinput" />
|
|
<div id="searchresults">
|
|
|
|
</div>
|
|
</div>
|
|
</form>
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
|
|
<fieldset>
|
|
<legend>Filters</legend>
|
|
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
|
|
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
|
|
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
|
|
</fieldset>
|
|
</form>
|
|
|
|
<h2>
|
|
|
|
|
|
<code>static</code>
|
|
|
|
Class <b property="yui:name">YAHOO.tool.Profiler</b>
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
|
|
|
|
|
|
<div class="summary description" property="yui:description">
|
|
Profiles functions in JavaScript.
|
|
</div>
|
|
|
|
|
|
<div rel="yui:properties" resource="#properties">
|
|
|
|
</div>
|
|
|
|
<div rel="yui:methods" resource="#methods">
|
|
<div class="section method details">
|
|
<h3 id="methods">Methods</h3>
|
|
<div class="content">
|
|
<div class="" rel="yui:method" resource="#method_clear">
|
|
<h4>
|
|
<a name="method_clear">clear</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Void
|
|
<strong property="yui:name">clear</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Removes all report data from the profiler.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> (Optional) The name of the report to clear. If
|
|
omitted, then all report data is cleared.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method_createReport">
|
|
<h4>
|
|
<a name="method_createReport">createReport</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
Void
|
|
<strong property="yui:name">createReport</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Creates a report object with the given name.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name to store for the report object.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getAverage">
|
|
<h4>
|
|
<a name="method_getAverage">getAverage</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
float
|
|
<strong property="yui:name">getAverage</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns the average amount of time (in milliseconds) that the function
|
|
with the given name takes to execute.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the function whose data should be returned.
|
|
If an object type method, it should be 'constructor.prototype.methodName';
|
|
a normal object method would just be 'object.methodName'.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
float
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">The average time it takes the function to execute.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getCallCount">
|
|
<h4>
|
|
<a name="method_getCallCount">getCallCount</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
int
|
|
<strong property="yui:name">getCallCount</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns the number of times that the given function has been called.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the function whose data should be returned.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
int
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">The number of times the function was called.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getFullReport">
|
|
<h4>
|
|
<a name="method_getFullReport">getFullReport</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Object
|
|
<strong property="yui:name">getFullReport</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns an object containing profiling data for all of the functions
|
|
that were profiled. The object has an entry for each function and
|
|
returns all information (min, max, average, calls, etc.) for each
|
|
function.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Object
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">An object containing all profile data.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class=" deprecated" rel="yui:method" resource="#method_getFunctionReport">
|
|
<h4>
|
|
<a name="method_getFunctionReport">getFunctionReport</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Object
|
|
<strong property="yui:name">getFunctionReport</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns an object containing profiling data for a single function.
|
|
The object has an entry for min, max, avg, calls, and points).
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Object
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">An object containing profile data for a given function.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<div class="deprecated">
|
|
<strong>Deprecated</strong> Use getReport() instead.
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getMax">
|
|
<h4>
|
|
<a name="method_getMax">getMax</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
float
|
|
<strong property="yui:name">getMax</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns the maximum amount of time (in milliseconds) that the function
|
|
with the given name takes to execute.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the function whose data should be returned.
|
|
If an object type method, it should be 'constructor.prototype.methodName';
|
|
a normal object method would just be 'object.methodName'.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
float
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">The maximum time it takes the function to execute.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getMin">
|
|
<h4>
|
|
<a name="method_getMin">getMin</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
float
|
|
<strong property="yui:name">getMin</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns the minimum amount of time (in milliseconds) that the function
|
|
with the given name takes to execute.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the function whose data should be returned.
|
|
If an object type method, it should be 'constructor.prototype.methodName';
|
|
a normal object method would just be 'object.methodName'.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
float
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">The minimum time it takes the function to execute.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getOriginal">
|
|
<h4>
|
|
<a name="method_getOriginal">getOriginal</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Function|Object
|
|
<strong property="yui:name">getOriginal</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns the uninstrumented version of a function/object.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the function/object to retrieve.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Function|Object
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">The uninstrumented version of a function/object.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getReport">
|
|
<h4>
|
|
<a name="method_getReport">getReport</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Object
|
|
<strong property="yui:name">getReport</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns an object containing profiling data for a single function.
|
|
The object has an entry for min, max, avg, calls, and points).
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Object
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">An object containing profile data for a given function.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_instrument">
|
|
<h4>
|
|
<a name="method_instrument">instrument</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Function
|
|
<strong property="yui:name">instrument</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
,
|
|
method
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Instruments a method to have profiling calls.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the report for the function.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">method</span>
|
|
<<span property="yui:type">Function</span>>
|
|
</code>
|
|
<span property="yui:description"> The function to instrument.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
Function
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">An instrumented version of the function.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_pause">
|
|
<h4>
|
|
<a name="method_pause">pause</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Void
|
|
<strong property="yui:name">pause</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Pauses profiling information for a given name.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the data point.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_registerConstructor">
|
|
<h4>
|
|
<a name="method_registerConstructor">registerConstructor</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Void
|
|
<strong property="yui:name">registerConstructor</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
,
|
|
owner
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Sets up a constructor for profiling, including all properties and methods on the prototype.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> The fully-qualified name of the function including namespace information.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">owner</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> (Optional) The object that owns the function (namespace or containing object).</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_registerFunction">
|
|
<h4>
|
|
<a name="method_registerFunction">registerFunction</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Void
|
|
<strong property="yui:name">registerFunction</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
,
|
|
owner
|
|
|
|
|
|
,
|
|
registerPrototype
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Sets up a function for profiling. It essentially overwrites the function with one
|
|
that has instrumentation data. This method also creates an entry for the function
|
|
in the profile report. The original function is stored on the container object.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The full name of the function including namespacing. This
|
|
is the name of the function that is stored in the report.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">owner</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> (Optional) The object that owns the function. If the function
|
|
isn't global then this argument is required. This could be the namespace that
|
|
the function belongs to, such as YAHOO.util.Dom, or the object on which it's
|
|
a method.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">registerPrototype</span>
|
|
<<span property="yui:type">Boolean</span>>
|
|
</code>
|
|
<span property="yui:description"> (Optional) Indicates that the prototype should
|
|
also be instrumented. Setting to true has the same effect as calling
|
|
registerConstructor().</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_registerObject">
|
|
<h4>
|
|
<a name="method_registerObject">registerObject</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Void
|
|
<strong property="yui:name">registerObject</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
,
|
|
owner
|
|
|
|
|
|
,
|
|
recurse
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Sets up an object for profiling. It takes the object and looks for functions.
|
|
When a function is found, registerMethod() is called on it. If set to recrusive
|
|
mode, it will also setup objects found inside of this object for profiling,
|
|
using the same methodology.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the object to profile (shows up in report).</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">owner</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> (Optional) The object represented by the name.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">recurse</span>
|
|
<<span property="yui:type">Boolean</span>>
|
|
</code>
|
|
<span property="yui:description"> (Optional) Determines if subobject methods are also profiled.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method_saveDataPoint">
|
|
<h4>
|
|
<a name="method_saveDataPoint">saveDataPoint</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
static
|
|
|
|
Void
|
|
<strong property="yui:name">saveDataPoint</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
,
|
|
duration
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Called when a method ends execution. Marks the start and end time of the
|
|
method so it can calculate how long the function took to execute. Also
|
|
updates min/max/avg calculations for the function.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the function to mark as stopped.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">duration</span>
|
|
<<span property="yui:type">int</span>>
|
|
</code>
|
|
<span property="yui:description"> The number of milliseconds it took the function to
|
|
execute.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_start">
|
|
<h4>
|
|
<a name="method_start">start</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Void
|
|
<strong property="yui:name">start</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Start profiling information for a given name. The name cannot be the name
|
|
of a registered function or object. This is used to start timing for a
|
|
particular block of code rather than instrumenting the entire function.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the data point.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_stop">
|
|
<h4>
|
|
<a name="method_stop">stop</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Void
|
|
<strong property="yui:name">stop</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Stops profiling information for a given name.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the data point.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_unregisterFunction">
|
|
<h4>
|
|
<a name="method_unregisterFunction">unregisterFunction</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Void
|
|
<strong property="yui:name">unregisterFunction</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Removes a constructor function from profiling. Reverses the registerConstructor() method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The full name of the function including namespacing. This
|
|
is the name of the function that is stored in the report.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_unregisterObject">
|
|
<h4>
|
|
<a name="method_unregisterObject">unregisterObject</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
Void
|
|
<strong property="yui:name">unregisterObject</strong>
|
|
(
|
|
|
|
|
|
name
|
|
|
|
|
|
,
|
|
recurse
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Unregisters an object for profiling. It takes the object and looks for functions.
|
|
When a function is found, unregisterMethod() is called on it. If set to recrusive
|
|
mode, it will also unregister objects found inside of this object,
|
|
using the same methodology.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">name</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The name of the object to unregister.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">recurse</span>
|
|
<<span property="yui:type">Boolean</span>>
|
|
</code>
|
|
<span property="yui:description"> (Optional) Determines if subobject methods should also be
|
|
unregistered.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div rel="yui:events" resource="#events">
|
|
|
|
|
|
</div>
|
|
|
|
<div rel="yui:attributes" resource="#configattributes">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div id="moduleList" class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="module_animation.html" title="animation">animation</a></li>
|
|
<li class=""><a href="module_autocomplete.html" title="autocomplete">autocomplete</a></li>
|
|
<li class=""><a href="module_button.html" title="button">button</a></li>
|
|
<li class=""><a href="module_calendar.html" title="calendar">calendar</a></li>
|
|
<li class=""><a href="module_carousel.html" title="carousel">carousel</a></li>
|
|
<li class=""><a href="module_charts.html" title="charts">charts</a></li>
|
|
<li class=""><a href="module_colorpicker.html" title="colorpicker">colorpicker</a></li>
|
|
<li class=""><a href="module_connection.html" title="connection">connection</a></li>
|
|
<li class=""><a href="module_container.html" title="container">container</a></li>
|
|
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
|
|
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
|
|
<li class=""><a href="module_datatable.html" title="datatable">datatable</a></li>
|
|
<li class=""><a href="module_datemath.html" title="datemath">datemath</a></li>
|
|
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
|
|
<li class=""><a href="module_dragdrop.html" title="dragdrop">dragdrop</a></li>
|
|
<li class=""><a href="module_editor.html" title="editor">editor</a></li>
|
|
<li class=""><a href="module_element.html" title="element">element</a></li>
|
|
<li class=""><a href="module_element-delegate.html" title="element-delegate">element-delegate</a></li>
|
|
<li class=""><a href="module_event.html" title="event">event</a></li>
|
|
<li class=""><a href="module_event-delegate.html" title="event-delegate">event-delegate</a></li>
|
|
<li class=""><a href="module_event-mouseenter.html" title="event-mouseenter">event-mouseenter</a></li>
|
|
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
|
|
<li class=""><a href="module_get.html" title="get">get</a></li>
|
|
<li class=""><a href="module_history.html" title="history">history</a></li>
|
|
<li class=""><a href="module_imagecropper.html" title="imagecropper">imagecropper</a></li>
|
|
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
|
|
<li class=""><a href="module_json.html" title="json">json</a></li>
|
|
<li class=""><a href="module_layout.html" title="layout">layout</a></li>
|
|
<li class=""><a href="module_logger.html" title="logger">logger</a></li>
|
|
<li class=""><a href="module_menu.html" title="menu">menu</a></li>
|
|
<li class=""><a href="module_paginator.html" title="paginator">paginator</a></li>
|
|
<li class="selected"><a href="module_profiler.html" title="profiler">profiler</a></li>
|
|
<li class=""><a href="module_profilerviewer.html" title="profilerviewer">profilerviewer</a></li>
|
|
<li class=""><a href="module_progressbar.html" title="progressbar">progressbar</a></li>
|
|
<li class=""><a href="module_resize.html" title="resize">resize</a></li>
|
|
<li class=""><a href="module_selector.html" title="selector">selector</a></li>
|
|
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
|
|
<li class=""><a href="module_storage.html" title="Storage">Storage</a></li>
|
|
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
|
|
<li class=""><a href="module_swf.html" title="swf">swf</a></li>
|
|
<li class=""><a href="module_swfdetect.html" title="swfdetect">swfdetect</a></li>
|
|
<li class=""><a href="module_swfstore.html" title="swfstore">swfstore</a></li>
|
|
<li class=""><a href="module_tabview.html" title="tabview">tabview</a></li>
|
|
<li class=""><a href="module_treeview.html" title="treeview">treeview</a></li>
|
|
<li class=""><a href="module_uploader.html" title="uploader">uploader</a></li>
|
|
<li class=""><a href="module_yahoo.html" title="yahoo">yahoo</a></li>
|
|
<li class=""><a href="module_yuiloader.html" title="yuiloader">yuiloader</a></li>
|
|
<li class=""><a href="module_yuitest.html" title="yuitest">yuitest</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="classList" class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li class="selected"><a href="YAHOO.tool.Profiler.html" title="YAHOO.tool.Profiler">YAHOO.tool.Profiler</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="fileList" class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="Profiler.js.html" title="Profiler.js">Profiler.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div id="methodsList" class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="#method_clear" title="clear">clear</a></li>
|
|
<li class="private"><a href="#method_createReport" title="createReport">createReport</a></li>
|
|
<li class=""><a href="#method_getAverage" title="getAverage">getAverage</a></li>
|
|
<li class=""><a href="#method_getCallCount" title="getCallCount">getCallCount</a></li>
|
|
<li class=""><a href="#method_getFullReport" title="getFullReport">getFullReport</a></li>
|
|
<li class=" deprecated"><a href="#method_getFunctionReport" title="getFunctionReport">getFunctionReport</a></li>
|
|
<li class=""><a href="#method_getMax" title="getMax">getMax</a></li>
|
|
<li class=""><a href="#method_getMin" title="getMin">getMin</a></li>
|
|
<li class=""><a href="#method_getOriginal" title="getOriginal">getOriginal</a></li>
|
|
<li class=""><a href="#method_getReport" title="getReport">getReport</a></li>
|
|
<li class=""><a href="#method_instrument" title="instrument">instrument</a></li>
|
|
<li class=""><a href="#method_pause" title="pause">pause</a></li>
|
|
<li class=""><a href="#method_registerConstructor" title="registerConstructor">registerConstructor</a></li>
|
|
<li class=""><a href="#method_registerFunction" title="registerFunction">registerFunction</a></li>
|
|
<li class=""><a href="#method_registerObject" title="registerObject">registerObject</a></li>
|
|
<li class="private"><a href="#method_saveDataPoint" title="saveDataPoint">saveDataPoint</a></li>
|
|
<li class=""><a href="#method_start" title="start">start</a></li>
|
|
<li class=""><a href="#method_stop" title="stop">stop</a></li>
|
|
<li class=""><a href="#method_unregisterFunction" title="unregisterFunction">unregisterFunction</a></li>
|
|
<li class=""><a href="#method_unregisterObject" title="unregisterObject">unregisterObject</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2010 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
|
|
var ALL_YUI_PROPS = [{"access": "", "host": "YAHOO.tool.Profiler", "name": "clear", "url": "YAHOO.tool.Profiler.html#method_clear", "type": "method"}, {"access": "private", "host": "YAHOO.tool.Profiler", "name": "createReport", "url": "YAHOO.tool.Profiler.html#method_createReport", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "getAverage", "url": "YAHOO.tool.Profiler.html#method_getAverage", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "getCallCount", "url": "YAHOO.tool.Profiler.html#method_getCallCount", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "getFullReport", "url": "YAHOO.tool.Profiler.html#method_getFullReport", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "getFunctionReport", "url": "YAHOO.tool.Profiler.html#method_getFunctionReport", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "getMax", "url": "YAHOO.tool.Profiler.html#method_getMax", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "getMin", "url": "YAHOO.tool.Profiler.html#method_getMin", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "getOriginal", "url": "YAHOO.tool.Profiler.html#method_getOriginal", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "getReport", "url": "YAHOO.tool.Profiler.html#method_getReport", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "instrument", "url": "YAHOO.tool.Profiler.html#method_instrument", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "pause", "url": "YAHOO.tool.Profiler.html#method_pause", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "registerConstructor", "url": "YAHOO.tool.Profiler.html#method_registerConstructor", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "registerFunction", "url": "YAHOO.tool.Profiler.html#method_registerFunction", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "registerObject", "url": "YAHOO.tool.Profiler.html#method_registerObject", "type": "method"}, {"access": "private", "host": "YAHOO.tool.Profiler", "name": "saveDataPoint", "url": "YAHOO.tool.Profiler.html#method_saveDataPoint", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "start", "url": "YAHOO.tool.Profiler.html#method_start", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "stop", "url": "YAHOO.tool.Profiler.html#method_stop", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "unregisterFunction", "url": "YAHOO.tool.Profiler.html#method_unregisterFunction", "type": "method"}, {"access": "", "host": "YAHOO.tool.Profiler", "name": "unregisterObject", "url": "YAHOO.tool.Profiler.html#method_unregisterObject", "type": "method"}];
|
|
</script>
|
|
</body>
|
|
</html>
|