252 lines
18 KiB
HTML
252 lines
18 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>YUI Library Examples: Profiler: Simple Profiling Example</title>
|
|
|
|
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8">
|
|
<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >
|
|
|
|
<style>
|
|
/*Supplemental CSS for the YUI distribution*/
|
|
#custom-doc { width: 95%; min-width: 950px; }
|
|
#pagetitle {background-image: url(../../assets/bg_hd.gif);}
|
|
</style>
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
|
|
<!--Script and CSS includes for YUI dependencies on this page-->
|
|
<link rel="stylesheet" type="text/css" href="../../build/logger/assets/skins/sam/logger.css" />
|
|
<link rel="stylesheet" type="text/css" href="../../build/button/assets/skins/sam/button.css" />
|
|
<script type="text/javascript" src="../../build/yuiloader/yuiloader-min.js"></script>
|
|
<script type="text/javascript" src="../../build/event/event-min.js"></script>
|
|
<script type="text/javascript" src="../../build/dom/dom-min.js"></script>
|
|
<script type="text/javascript" src="../../build/logger/logger-min.js"></script>
|
|
<script type="text/javascript" src="../../build/profiler/profiler-debug.js"></script>
|
|
<script type="text/javascript" src="../../build/element/element-min.js"></script>
|
|
<script type="text/javascript" src="../../build/button/button-min.js"></script>
|
|
|
|
<!--there is no custom header content for this example-->
|
|
|
|
|
|
<script type="text/javascript">
|
|
//enable passthrough of errors from YUI Event:
|
|
if ((typeof YAHOO !== "undefined") && (YAHOO.util) && (YAHOO.util.Event)) {
|
|
YAHOO.util.Event.throwErrors = true;
|
|
}
|
|
</script>
|
|
</head>
|
|
<body id="yahoo-com" class="yui-skin-sam">
|
|
<div id="custom-doc" class="yui-t2">
|
|
<div id="hd">
|
|
<div id="ygunav">
|
|
<p><em><a href="http://developer.yahoo.com/yui/">YUI Library Home</a></em></p>
|
|
<form action="http://search.yahoo.com/search" id="sitesearchform">
|
|
<input name="vs" type="hidden" value="developer.yahoo.com">
|
|
<input name="vs" type="hidden" value="yuiblog.com">
|
|
<div id="sitesearch">
|
|
<label for="searchinput">Site Search (YDN & YUIBlog): </label>
|
|
<input type="text" id="searchinput" name="p">
|
|
<input type="submit" value="Search" id="searchsubmit" class="ygbt">
|
|
</div>
|
|
</form> </div>
|
|
<div id="ygma"><a href="../../"><img src="../../assets/yui.gif" border="0" height="38"></a></div>
|
|
<div id="pagetitle"><h1>YUI Library Examples: Profiler: Simple Profiling Example</h1></div>
|
|
</div>
|
|
<div id="bd">
|
|
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<div class="yui-ge">
|
|
<div class="yui-u first example">
|
|
|
|
|
|
<div class="promo">
|
|
<h1>Profiler: Simple Profiling Example</h1>
|
|
|
|
<div class="exampleIntro">
|
|
<p>This example shows basic usage of the Profiler for profiling a single function. A single function is
|
|
profiled and all of the information displayed.</p>
|
|
</div>
|
|
|
|
<div class="example-container module ">
|
|
<div id="example-canvas" class="bd">
|
|
|
|
|
|
<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== -->
|
|
|
|
<h3>Note:</h3>
|
|
<p>Keep an eye on the Logger console at right to see the profiling information being reported.</p>
|
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
YAHOO.namespace("example.profiler");
|
|
|
|
//object with method to profile
|
|
YAHOO.example.profiler.MathHelper = {
|
|
factorial : function (num){
|
|
if (num > 1) {
|
|
return num * YAHOO.example.profiler.MathHelper.factorial(num-1);
|
|
} else {
|
|
return 1;
|
|
}
|
|
}
|
|
};
|
|
|
|
//register the function
|
|
YAHOO.tool.Profiler.registerFunction("YAHOO.example.profiler.MathHelper.factorial");
|
|
|
|
|
|
YAHOO.util.Event.onDOMReady(function (){
|
|
|
|
YAHOO.example.profiler.MathHelper.factorial(10);
|
|
|
|
var calls = YAHOO.tool.Profiler.getCallCount("YAHOO.example.profiler.MathHelper.factorial");
|
|
var max = YAHOO.tool.Profiler.getMax("YAHOO.example.profiler.MathHelper.factorial");
|
|
var min = YAHOO.tool.Profiler.getMin("YAHOO.example.profiler.MathHelper.factorial");
|
|
var avg = YAHOO.tool.Profiler.getAverage("YAHOO.example.profiler.MathHelper.factorial");
|
|
|
|
YAHOO.tool.Profiler.unregisterFunction("YAHOO.example.profiler.MathHelper.factorial");
|
|
|
|
YAHOO.log("Method YAHOO.example.profiler.MathHelper was run " + calls + "times.");
|
|
YAHOO.log("The average time was " + avg + "ms.");
|
|
YAHOO.log("The max time was " + max + " ms.");
|
|
YAHOO.log("The min time was " + min + " ms.");
|
|
|
|
});
|
|
|
|
</script>
|
|
<!--END SOURCE CODE FOR EXAMPLE =============================== -->
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="first">Simple Profiling Example</h2>
|
|
|
|
<p>This example begins by creating a namespace:</p>
|
|
<textarea name="code" class="JScript" cols="60" rows="1">
|
|
YAHOO.namespace("example.profiler");
|
|
</textarea>
|
|
<p>This namespace serves as the core object upon which others will be added (to prevent creating global objects).</p>
|
|
<p>Next, an object is created with a method:</p>
|
|
<textarea name="code" class="JScript" cols="60" rows="1">
|
|
//object with method to profile
|
|
YAHOO.example.profiler.MathHelper = {
|
|
factorial : function (num){
|
|
if (num > 1) {
|
|
return num * MathHelper.factorial(num-1);
|
|
} else {
|
|
return 1;
|
|
}
|
|
}
|
|
};
|
|
</textarea>
|
|
<p>This object, <code>MathHelper</code> contains a single method called <code>factorial()</code> that computes the
|
|
factorial of a given number. Any time <code>factorial()</code> is called, the argument indicates how many times
|
|
the function will be recursively called. For example, <code>factorial(10)</code> results in the funtion being
|
|
called 10 times. This makes it an ideal test case for profiling because the results are so predictable.</p>
|
|
<h3>Registering the function</h3>
|
|
<p>The most important step to profile this function is to call <code>registerFunction()</code> with the fully-qualified
|
|
function name, which is <code>YAHOO.example.profiler.MathHelper</code>:</p>
|
|
<textarea name="code" class="JScript" cols="60" rows="1">
|
|
YAHOO.tool.Profiler.registerFunction("YAHOO.example.profiler.MathHelper.factorial");
|
|
</textarea>
|
|
<p>Since this function is fully accessible in the global scope, there's no need to provide the owner object
|
|
as the second argument.</p>
|
|
|
|
<h3>Running the example</h3>
|
|
|
|
<p>With everything setup, the last step is to run the code. This initialization is assigned to take place when the document tree has been
|
|
completely loaded by using the Event utility's <code>onDOMReady()</code> method:</p>
|
|
|
|
<textarea name="code" class="JScript" cols="60" rows="1">
|
|
YAHOO.util.Event.onDOMReady(function (){
|
|
|
|
YAHOO.example.profiler.MathHelper.factorial(10);
|
|
|
|
var calls = YAHOO.tool.Profiler.getCallCount("YAHOO.example.profiler.MathHelper.factorial");
|
|
var max = YAHOO.tool.Profiler.getMax("YAHOO.example.profiler.MathHelper.factorial");
|
|
var min = YAHOO.tool.Profiler.getMin("YAHOO.example.profiler.MathHelper.factorial");
|
|
var avg = YAHOO.tool.Profiler.getAverage("YAHOO.example.profiler.MathHelper.factorial");
|
|
|
|
YAHOO.tool.Profiler.unregisterFunction("YAHOO.example.profiler.MathHelper.factorial");
|
|
|
|
YAHOO.log("Method YAHOO.example.profiler.MathHelper was run " + calls + "times.");
|
|
YAHOO.log("The average time was " + avg + "ms.");
|
|
YAHOO.log("The max time was " + max + " ms.");
|
|
YAHOO.log("The min time was " + min + " ms.");
|
|
});
|
|
</textarea>
|
|
<p>The code block begins by calling <code>factorial()</code> once, which gets profiled. Then, the information
|
|
about the function can be retrieved from the Profiler. This information is output into the Logger on the page,
|
|
displaying the number of times that the function was called along with the minimum, maximum, and average
|
|
running times. Since this is a very simple function, the run times will most likely be 0ms on most machines.</p>
|
|
<h2>Configuration for This Example</h2>
|
|
|
|
<p>You can load the necessary JavaScript and CSS for this example from Yahoo's servers. <a href="http://developer.yahoo.com/yui/articles/hosting/?yahoo&profiler&MIN#configure">Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured</a>.</p>
|
|
|
|
</div>
|
|
<div class="yui-u">
|
|
<div id="loggerModule" class="yui-skin-sam">
|
|
<h3 class="firstContent">YUI Logger Output:</h3>
|
|
<div id="loggerDiv"></div>
|
|
</div>
|
|
|
|
|
|
<div id="examples">
|
|
<h3>Profiler Examples:</h3>
|
|
|
|
<div id="exampleToc">
|
|
<ul>
|
|
<li class='selected'><a href='../profiler/profiler-simple-example.html'>Simple Profiling Example</a></li><li><a href='../profiler/profiler-object-example.html'>Object Profiling Example</a></li> </ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="module">
|
|
<h3>More Profiler Resources:</h3>
|
|
<ul>
|
|
<li><a href="http://developer.yahoo.com/yui/profiler/">User's Guide</a> (external)</li>
|
|
<li><a href="../../docs/module_profiler.html">API Documentation</a></li>
|
|
|
|
|
|
<li><a href="http://yuiblog.com/assets/pdf/cheatsheets/profiler.pdf">Cheat Sheet PDF</a> (external)</li></ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="yui-b" id="tocWrapper">
|
|
<!-- TABLE OF CONTENTS -->
|
|
<div id="toc">
|
|
|
|
<ul>
|
|
<li class="sect first">Yahoo! UI Library</li><li class="item"><a title="The Yahoo! User Interface Library (YUI)" href="http://developer.yahoo.com/yui/">Home (external)</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUIBlog (external)</a></li><li class="item"><a title="YUILibrary.com hosts the YUI community forums" href="http://yuilibrary.com/forum/">YUI Discussion Forum (external)</a></li><li class="item"><a title="The YUI Library source can be checked out from GitHub" href="http://github.com/yui/">YUI on GitHub</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../docs/index.html">API Documentation</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">Functional Examples</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License (external)</a></li><li class="sect">YUI Functional Examples</li><li class="item"><a title="The YUI Animation Utility - Functional Examples" href="../../examples/animation/index.html">Animation</a></li><li class="item"><a title="The YUI AutoComplete Control - Functional Examples" href="../../examples/autocomplete/index.html">AutoComplete</a></li><li class="item"><a title="The YUI Browser History Manager - Functional Examples" href="../../examples/history/index.html">Browser History Manager</a></li><li class="item"><a title="The YUI Button Control - Functional Examples" href="../../examples/button/index.html">Button</a></li><li class="item"><a title="The YUI Calendar Control - Functional Examples" href="../../examples/calendar/index.html">Calendar</a></li><li class="item"><a title="The YUI Carousel Control - Functional Examples" href="../../examples/carousel/index.html">Carousel</a></li><li class="item"><a title="The YUI Charts Control - Functional Examples" href="../../examples/charts/index.html">Charts</a></li><li class="item"><a title="The YUI Color Picker Control - Functional Examples" href="../../examples/colorpicker/index.html">Color Picker</a></li><li class="item"><a title="The YUI Cookie Utility - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="The YUI Connection Manager (AJAX) - Functional Examples" href="../../examples/connection/index.html">Connection Manager</a></li><li class="item"><a title="The YUI Container Family (Module, Overlay, Tooltip, Panel, Dialog, SimpleDialog) - Functional Examples" href="../../examples/container/index.html">Container</a></li><li class="item"><a title="The YUI DataTable Control - Functional Examples" href="../../examples/datatable/index.html">DataTable</a></li><li class="item"><a title="The YUI Dom Collection - Functional Examples" href="../../examples/dom/index.html">Dom</a></li><li class="item"><a title="The YUI Drag & Drop Utility - Functional Examples" href="../../examples/dragdrop/index.html">Drag & Drop</a></li><li class="item"><a title="The YUI Event Utility - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="The YUI Get Utility - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="The YUI ImageCropper Control - Functional Examples" href="../../examples/imagecropper/index.html">ImageCropper</a></li><li class="item"><a title="The YUI ImageLoader Utility - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="The YUI JSON Utility - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="The YUI Layout Manager - Functional Examples" href="../../examples/layout/index.html">Layout Manager</a></li><li class="item"><a title="The YUI Logger Control - Functional Examples" href="../../examples/logger/index.html">Logger</a></li><li class="item"><a title="The YUI Menu Control - Functional Examples" href="../../examples/menu/index.html">Menu</a></li><li class="item"><a title="The YUI Paginator - Functional Examples" href="../../examples/paginator/index.html">Paginator</a></li><li class="selected "><a title="The YUI Profiler Utility - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="The YUI ProfileViewer Control - Functional Examples" href="../../examples/profilerviewer/index.html">ProfilerViewer</a></li><li class="item"><a title="The YUI ProgressBar Control - Functional Examples" href="../../examples/progressbar/index.html">ProgressBar</a></li><li class="item"><a title="The YUI Resize Utility - Functional Examples" href="../../examples/resize/index.html">Resize</a></li><li class="item"><a title="The YUI Rich Text Editor - Functional Examples" href="../../examples/editor/index.html">Rich Text Editor</a></li><li class="item"><a title="The YUI Selector Utility - Functional Examples" href="../../examples/selector/index.html">Selector</a></li><li class="item"><a title="The YUI Slider Control - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="item"><a title="The YUI Storage Utility - Functional Examples" href="../../examples/storage/index.html">Storage</a></li><li class="item"><a title="The YUI SWF Utility - Functional Examples" href="../../examples/swf/index.html">SWF</a></li><li class="item"><a title="The YUI SWFStore Utility - Functional Examples" href="../../examples/swfstore/index.html">SWFStore</a></li><li class="item"><a title="The YUI Stylesheet Utility - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="item"><a title="The YUI TabView Control - Functional Examples" href="../../examples/tabview/index.html">TabView</a></li><li class="item"><a title="The YUI TreeView Control - Functional Examples" href="../../examples/treeview/index.html">TreeView</a></li><li class="item"><a title="The YUI Uploader Utility - Functional Examples" href="../../examples/uploader/index.html">Uploader (experimental)</a></li><li class="item"><a title="The YUI YAHOO Global Object - Functional Examples" href="../../examples/yahoo/index.html">YAHOO Global Object</a></li><li class="item"><a title="The YUI Loader Utility - Functional Examples" href="../../examples/yuiloader/index.html">YUI Loader</a></li><li class="item"><a title="The YUI Test Utility - Functional Examples" href="../../examples/yuitest/index.html">YUI Test</a></li><li class="item"><a title="YUI Reset CSS - Functional Examples" href="../../examples/reset/index.html">Reset CSS</a></li><li class="item"><a title="YUI Base CSS - Functional Examples" href="../../examples/base/index.html">Base CSS</a></li><li class="item"><a title="YUI Fonts CSS - Functional Examples" href="../../examples/fonts/index.html">Fonts CSS</a></li><li class="item"><a title="YUI Grids CSS - Functional Examples" href="../../examples/grids/index.html">Grids CSS</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li><li class="item"><a title="Best practices for working with web services while protecting user privacy" href="http://developer.yahoo.com/security/">Security Best Practices (external)</a></li></ul>
|
|
</div>
|
|
</div>
|
|
</div><!--closes bd-->
|
|
|
|
<div id="ft">
|
|
<p class="first">Copyright © 2009 Yahoo! Inc. All rights reserved.</p>
|
|
<p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> -
|
|
<a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> -
|
|
<a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> -
|
|
<a href="http://careers.yahoo.com/">Job Openings</a></p>
|
|
</div>
|
|
</div>
|
|
<script src="../../assets/dpSyntaxHighlighter.js"></script>
|
|
<script language="javascript">
|
|
dp.SyntaxHighlighter.HighlightAll('code');
|
|
</script>
|
|
|
|
<script src='../../assets/YUIexamples.js'></script>
|
|
|
|
|
|
</body>
|
|
</html>
|