pv.Area.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="JsDoc Toolkit" />
  7. <title>JsDoc Reference - pv.Area</title>
  8. <style type="text/css">
  9. /* default.css */
  10. body
  11. {
  12. font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
  13. width: 800px;
  14. }
  15. .header
  16. {
  17. clear: both;
  18. background-color: #ccc;
  19. padding: 8px;
  20. }
  21. h1
  22. {
  23. font-size: 150%;
  24. font-weight: bold;
  25. padding: 0;
  26. margin: 1em 0 0 .3em;
  27. }
  28. hr
  29. {
  30. border: none 0;
  31. border-top: 1px solid #7F8FB1;
  32. height: 1px;
  33. }
  34. pre.code
  35. {
  36. display: block;
  37. padding: 8px;
  38. border: 1px dashed #ccc;
  39. }
  40. #index
  41. {
  42. margin-top: 24px;
  43. float: left;
  44. width: 160px;
  45. position: absolute;
  46. left: 8px;
  47. background-color: #F3F3F3;
  48. padding: 8px;
  49. }
  50. #content
  51. {
  52. margin-left: 190px;
  53. width: 600px;
  54. }
  55. .classList
  56. {
  57. list-style-type: none;
  58. padding: 0;
  59. margin: 0 0 0 8px;
  60. font-family: arial, sans-serif;
  61. font-size: 1em;
  62. overflow: auto;
  63. }
  64. .classList li
  65. {
  66. padding: 0;
  67. margin: 0 0 8px 0;
  68. }
  69. .summaryTable { width: 100%; }
  70. h1.classTitle
  71. {
  72. font-size:170%;
  73. line-height:130%;
  74. }
  75. h2 { font-size: 110%; }
  76. caption, div.sectionTitle
  77. {
  78. background-color: #7F8FB1;
  79. color: #fff;
  80. font-size:130%;
  81. text-align: left;
  82. padding: 2px 6px 2px 6px;
  83. border: 1px #7F8FB1 solid;
  84. }
  85. div.sectionTitle { margin-bottom: 8px; }
  86. .summaryTable thead { display: none; }
  87. .summaryTable td
  88. {
  89. vertical-align: top;
  90. padding: 4px;
  91. border-bottom: 1px #7F8FB1 solid;
  92. border-right: 1px #7F8FB1 solid;
  93. }
  94. /*col#summaryAttributes {}*/
  95. .summaryTable td.attributes
  96. {
  97. border-left: 1px #7F8FB1 solid;
  98. width: 140px;
  99. text-align: right;
  100. }
  101. td.attributes, .fixedFont
  102. {
  103. line-height: 15px;
  104. color: #002EBE;
  105. font-family: "Courier New",Courier,monospace;
  106. font-size: 13px;
  107. }
  108. .summaryTable td.nameDescription
  109. {
  110. text-align: left;
  111. font-size: 13px;
  112. line-height: 15px;
  113. }
  114. .summaryTable td.nameDescription, .description
  115. {
  116. line-height: 15px;
  117. padding: 4px;
  118. padding-left: 4px;
  119. }
  120. pre
  121. {
  122. border-left: solid 10px #ddd;
  123. padding-left: 1.5em;
  124. }
  125. .summaryTable { margin-bottom: 8px; }
  126. ul.inheritsList
  127. {
  128. list-style: square;
  129. margin-left: 20px;
  130. padding-left: 0;
  131. }
  132. .detailList {
  133. margin-left: 20px;
  134. line-height: 15px;
  135. }
  136. .detailList dt { margin-left: 20px; }
  137. .detailList .heading
  138. {
  139. font-weight: bold;
  140. padding-bottom: 6px;
  141. margin-left: 0;
  142. }
  143. .light, td.attributes, .light a:link, .light a:visited
  144. {
  145. color: #777;
  146. font-style: italic;
  147. }
  148. .fineprint
  149. {
  150. text-align: right;
  151. font-size: 10px;
  152. }
  153. </style>
  154. </head>
  155. <body>
  156. <!-- ============================== header ================================= -->
  157. <!-- begin static/header.html -->
  158. <div id="header">
  159. </div>
  160. <!-- end static/header.html -->
  161. <!-- ============================== classes index ============================ -->
  162. <div id="index">
  163. <!-- begin publish.classesIndex -->
  164. <div align="center"><a href="../index.html">Class Index</a>
  165. | <a href="../files.html">File Index</a></div>
  166. <hr />
  167. <h2>Classes</h2>
  168. <ul class="classList">
  169. <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
  170. <li><a href="../symbols/Array.html">Array</a></li>
  171. <li><a href="../symbols/Date.html">Date</a></li>
  172. <li><a href="../symbols/pv.html">pv</a></li>
  173. <li><a href="../symbols/pv.Anchor.html">pv.Anchor</a></li>
  174. <li><a href="../symbols/pv.Area.html">pv.Area</a></li>
  175. <li><a href="../symbols/pv.Bar.html">pv.Bar</a></li>
  176. <li><a href="../symbols/pv.Color.html">pv.Color</a></li>
  177. <li><a href="../symbols/pv.Color.Hsl.html">pv.Color.Hsl</a></li>
  178. <li><a href="../symbols/pv.Color.Rgb.html">pv.Color.Rgb</a></li>
  179. <li><a href="../symbols/pv.Colors.html">pv.Colors</a></li>
  180. <li><a href="../symbols/pv.Dot.html">pv.Dot</a></li>
  181. <li><a href="../symbols/pv.Flatten.html">pv.Flatten</a></li>
  182. <li><a href="../symbols/pv.Image.html">pv.Image</a></li>
  183. <li><a href="../symbols/pv.Label.html">pv.Label</a></li>
  184. <li><a href="../symbols/pv.Layout.grid.html">pv.Layout.grid</a></li>
  185. <li><a href="../symbols/pv.Layout.icicle.html">pv.Layout.icicle</a></li>
  186. <li><a href="../symbols/pv.Layout.stack.html">pv.Layout.stack</a></li>
  187. <li><a href="../symbols/pv.Layout.sunburst.html">pv.Layout.sunburst</a></li>
  188. <li><a href="../symbols/pv.Layout.treemap.html">pv.Layout.treemap</a></li>
  189. <li><a href="../symbols/pv.Line.html">pv.Line</a></li>
  190. <li><a href="../symbols/pv.Mark.html">pv.Mark</a></li>
  191. <li><a href="../symbols/pv.Nest.html">pv.Nest</a></li>
  192. <li><a href="../symbols/pv.ns.html">pv.ns</a></li>
  193. <li><a href="../symbols/pv.Panel.html">pv.Panel</a></li>
  194. <li><a href="../symbols/pv.Rule.html">pv.Rule</a></li>
  195. <li><a href="../symbols/pv.Scale.linear.html">pv.Scale.linear</a></li>
  196. <li><a href="../symbols/pv.Scale.log.html">pv.Scale.log</a></li>
  197. <li><a href="../symbols/pv.Scale.ordinal.html">pv.Scale.ordinal</a></li>
  198. <li><a href="../symbols/pv.Tree.html">pv.Tree</a></li>
  199. <li><a href="../symbols/pv.Vector.html">pv.Vector</a></li>
  200. <li><a href="../symbols/pv.version.html">pv.version</a></li>
  201. <li><a href="../symbols/pv.Wedge.html">pv.Wedge</a></li>
  202. </ul>
  203. <hr />
  204. <!-- end publish.classesIndex -->
  205. </div>
  206. <div id="content">
  207. <!-- ============================== class title ============================ -->
  208. <h1 class="classTitle">
  209. Class pv.Area
  210. </h1>
  211. <!-- ============================== class summary ========================== -->
  212. <p class="description">
  213. <br />Extends
  214. <a href="../symbols/pv.Mark.html">pv.Mark</a>.<br />
  215. Represents an area mark: the solid area between two series of
  216. connected line segments. Unsurprisingly, areas are used most frequently for
  217. area charts.
  218. <p>Just as a line represents a polyline, the <tt>Area</tt> mark type
  219. represents a <i>polygon</i>. However, an area is not an arbitrary polygon;
  220. vertices are paired either horizontally or vertically into parallel
  221. <i>spans</i>, and each span corresponds to an associated datum. Either the
  222. width or the height must be specified, but not both; this determines whether
  223. the area is horizontally-oriented or vertically-oriented. Like lines, areas
  224. can be stroked and filled with arbitrary colors.
  225. <p>See also the <a href="../../api/Area.html">Area guide</a>.
  226. <br /><i>Defined in: </i> <a href="../symbols/src/mark_Area.js.html">Area.js</a>.
  227. </p>
  228. <!-- ============================== constructor summary ==================== -->
  229. <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pv.Area.">
  230. <caption>Class Summary</caption>
  231. <thead>
  232. <tr>
  233. <th scope="col">Constructor Attributes</th>
  234. <th scope="col">Constructor Name and Description</th>
  235. </tr>
  236. </thead>
  237. <tbody>
  238. <tr>
  239. <td class="attributes">&nbsp;</td>
  240. <td class="nameDescription" >
  241. <div class="fixedFont">
  242. <b><a href="../symbols/pv.Area.html#constructor">pv.Area</a></b>()
  243. </div>
  244. <div class="description">Constructs a new area mark with default properties.</div>
  245. </td>
  246. </tr>
  247. </tbody>
  248. </table>
  249. <!-- ============================== properties summary ===================== -->
  250. <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class pv.Area.">
  251. <caption>Field Summary</caption>
  252. <thead>
  253. <tr>
  254. <th scope="col">Field Attributes</th>
  255. <th scope="col">Field Name and Description</th>
  256. </tr>
  257. </thead>
  258. <tbody>
  259. <tr>
  260. <td class="attributes">&nbsp;</td>
  261. <td class="nameDescription">
  262. <div class="fixedFont">
  263. <b><a href="../symbols/pv.Area.html#defaults">defaults</a></b>
  264. </div>
  265. <div class="description">Default properties for areas.</div>
  266. </td>
  267. </tr>
  268. <tr>
  269. <td class="attributes">&nbsp;</td>
  270. <td class="nameDescription">
  271. <div class="fixedFont">
  272. <b><a href="../symbols/pv.Area.html#fillStyle">fillStyle</a></b>
  273. </div>
  274. <div class="description">The area fill style; if non-null, the interior of the polygon forming the
  275. area is filled with the specified color.</div>
  276. </td>
  277. </tr>
  278. <tr>
  279. <td class="attributes">&nbsp;</td>
  280. <td class="nameDescription">
  281. <div class="fixedFont">
  282. <b><a href="../symbols/pv.Area.html#height">height</a></b>
  283. </div>
  284. <div class="description">The height of a given span, in pixels; used for vertical spans.</div>
  285. </td>
  286. </tr>
  287. <tr>
  288. <td class="attributes">&nbsp;</td>
  289. <td class="nameDescription">
  290. <div class="fixedFont">
  291. <b><a href="../symbols/pv.Area.html#interpolate">interpolate</a></b>
  292. </div>
  293. <div class="description">How to interpolate between values.</div>
  294. </td>
  295. </tr>
  296. <tr>
  297. <td class="attributes">&nbsp;</td>
  298. <td class="nameDescription">
  299. <div class="fixedFont">
  300. <b><a href="../symbols/pv.Area.html#lineWidth">lineWidth</a></b>
  301. </div>
  302. <div class="description">The width of stroked lines, in pixels; used in conjunction with
  303. <tt>strokeStyle</tt> to stroke the perimeter of the area.</div>
  304. </td>
  305. </tr>
  306. <tr>
  307. <td class="attributes">&nbsp;</td>
  308. <td class="nameDescription">
  309. <div class="fixedFont">
  310. <b><a href="../symbols/pv.Area.html#segmented">segmented</a></b>
  311. </div>
  312. <div class="description">Whether the area is segmented; whether variations in fill style, stroke
  313. style, and the other properties are treated as fixed.</div>
  314. </td>
  315. </tr>
  316. <tr>
  317. <td class="attributes">&nbsp;</td>
  318. <td class="nameDescription">
  319. <div class="fixedFont">
  320. <b><a href="../symbols/pv.Area.html#strokeStyle">strokeStyle</a></b>
  321. </div>
  322. <div class="description">The style of stroked lines; used in conjunction with <tt>lineWidth</tt> to
  323. stroke the perimeter of the area.</div>
  324. </td>
  325. </tr>
  326. <tr>
  327. <td class="attributes">&nbsp;</td>
  328. <td class="nameDescription">
  329. <div class="fixedFont">
  330. <b><a href="../symbols/pv.Area.html#width">width</a></b>
  331. </div>
  332. <div class="description">The width of a given span, in pixels; used for horizontal spans.</div>
  333. </td>
  334. </tr>
  335. </tbody>
  336. </table>
  337. <dl class="inheritsList">
  338. <dt>Fields borrowed from class <a href="../symbols/pv.Mark.html">pv.Mark</a>: </dt><dd><a href="../symbols/pv.Mark.html#bottom">bottom</a>, <a href="../symbols/pv.Mark.html#childIndex">childIndex</a>, <a href="../symbols/pv.Mark.html#cursor">cursor</a>, <a href="../symbols/pv.Mark.html#data">data</a>, <a href="../symbols/pv.Mark.html#index">index</a>, <a href="../symbols/pv.Mark.html#left">left</a>, <a href="../symbols/pv.Mark.html#parent">parent</a>, <a href="../symbols/pv.Mark.html#proto">proto</a>, <a href="../symbols/pv.Mark.html#reverse">reverse</a>, <a href="../symbols/pv.Mark.html#right">right</a>, <a href="../symbols/pv.Mark.html#root">root</a>, <a href="../symbols/pv.Mark.html#scene">scene</a>, <a href="../symbols/pv.Mark.html#title">title</a>, <a href="../symbols/pv.Mark.html#top">top</a>, <a href="../symbols/pv.Mark.html#type">type</a>, <a href="../symbols/pv.Mark.html#visible">visible</a></dd>
  339. </dl>
  340. <!-- ============================== methods summary ======================== -->
  341. <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pv.Area.">
  342. <caption>Method Summary</caption>
  343. <thead>
  344. <tr>
  345. <th scope="col">Method Attributes</th>
  346. <th scope="col">Method Name and Description</th>
  347. </tr>
  348. </thead>
  349. <tbody>
  350. <tr>
  351. <td class="attributes">&nbsp;</td>
  352. <td class="nameDescription">
  353. <div class="fixedFont"><b><a href="../symbols/pv.Area.html#anchor">anchor</a></b>(name)
  354. </div>
  355. <div class="description">Constructs a new area anchor with default properties.</div>
  356. </td>
  357. </tr>
  358. </tbody>
  359. </table>
  360. <dl class="inheritsList">
  361. <dt>Methods borrowed from class <a href="../symbols/pv.Mark.html">pv.Mark</a>: </dt><dd><a href="../symbols/pv.Mark.html#add">add</a>, <a href="../symbols/pv.Mark.html#anchorTarget">anchorTarget</a>, <a href="../symbols/pv.Mark.html#cousin">cousin</a>, <a href="../symbols/pv.Mark.html#def">def</a>, <a href="../symbols/pv.Mark.html#event">event</a>, <a href="../symbols/pv.Mark.html#extend">extend</a>, <a href="../symbols/pv.Mark.html#first">first</a>, <a href="../symbols/pv.Mark.html#last">last</a>, <a href="../symbols/pv.Mark.html#mouse">mouse</a>, <a href="../symbols/pv.Mark.html#render">render</a>, <a href="../symbols/pv.Mark.html#sibling">sibling</a></dd>
  362. </dl>
  363. <!-- ============================== events summary ======================== -->
  364. <!-- ============================== constructor details ==================== -->
  365. <div class="details"><a name="constructor"> </a>
  366. <div class="sectionTitle">
  367. Class Detail
  368. </div>
  369. <div class="fixedFont">
  370. <b>pv.Area</b>()
  371. </div>
  372. <div class="description">
  373. Constructs a new area mark with default properties. Areas are not typically
  374. constructed directly, but by adding to a panel or an existing mark via
  375. <a href="../symbols/pv.Mark.html#add">pv.Mark#add</a>.
  376. </div>
  377. </div>
  378. <!-- ============================== field details ========================== -->
  379. <div class="sectionTitle">
  380. Field Detail
  381. </div>
  382. <a name="defaults"> </a>
  383. <div class="fixedFont">
  384. <span class="light">{<a href="../symbols/pv.Area.html">pv.Area</a>}</span>
  385. <b>defaults</b>
  386. </div>
  387. <div class="description">
  388. Default properties for areas. By default, there is no stroke and the fill
  389. style is a categorical color.
  390. </div>
  391. <hr />
  392. <a name="fillStyle"> </a>
  393. <div class="fixedFont">
  394. <span class="light">{string}</span>
  395. <b>fillStyle</b>
  396. </div>
  397. <div class="description">
  398. The area fill style; if non-null, the interior of the polygon forming the
  399. area is filled with the specified color. The default value of this property
  400. is a categorical color.
  401. <p>This property is <i>fixed</i> for non-segmented areas. See
  402. <a href="../symbols/pv.Mark.html">pv.Mark</a>.
  403. </div>
  404. <dl class="detailList">
  405. <dt class="heading">See:</dt>
  406. <dd><a href="../symbols/pv.html#.color">pv.color</a></dd>
  407. </dl>
  408. <hr />
  409. <a name="height"> </a>
  410. <div class="fixedFont">
  411. <span class="light">{number}</span>
  412. <b>height</b>
  413. </div>
  414. <div class="description">
  415. The height of a given span, in pixels; used for vertical spans. If the height
  416. is specified, the width property should be 0 (the default). Either the left
  417. or right property should be used to space the spans horizontally, typically
  418. as a multiple of the index.
  419. </div>
  420. <hr />
  421. <a name="interpolate"> </a>
  422. <div class="fixedFont">
  423. <span class="light">{string}</span>
  424. <b>interpolate</b>
  425. </div>
  426. <div class="description">
  427. How to interpolate between values. Linear interpolation ("linear") is the
  428. default, producing a straight line between points. For piecewise constant
  429. functions (i.e., step functions), either "step-before" or "step-after" can be
  430. specified.
  431. <p>Note: this property is currently supported only on non-segmented areas.
  432. <p>This property is <i>fixed</i>. See <a href="../symbols/pv.Mark.html">pv.Mark</a>.
  433. </div>
  434. <hr />
  435. <a name="lineWidth"> </a>
  436. <div class="fixedFont">
  437. <span class="light">{number}</span>
  438. <b>lineWidth</b>
  439. </div>
  440. <div class="description">
  441. The width of stroked lines, in pixels; used in conjunction with
  442. <tt>strokeStyle</tt> to stroke the perimeter of the area. Unlike the
  443. Line mark type, the entire perimeter is stroked, rather than just one
  444. edge. The default value of this property is 1.5, but since the default stroke
  445. style is null, area marks are not stroked by default.
  446. <p>This property is <i>fixed</i> for non-segmented areas. See
  447. <a href="../symbols/pv.Mark.html">pv.Mark</a>.
  448. </div>
  449. <hr />
  450. <a name="segmented"> </a>
  451. <div class="fixedFont">
  452. <span class="light">{boolean}</span>
  453. <b>segmented</b>
  454. </div>
  455. <div class="description">
  456. Whether the area is segmented; whether variations in fill style, stroke
  457. style, and the other properties are treated as fixed. Rendering segmented
  458. areas is noticeably slower than non-segmented areas.
  459. <p>This property is <i>fixed</i>. See <a href="../symbols/pv.Mark.html">pv.Mark</a>.
  460. </div>
  461. <hr />
  462. <a name="strokeStyle"> </a>
  463. <div class="fixedFont">
  464. <span class="light">{string}</span>
  465. <b>strokeStyle</b>
  466. </div>
  467. <div class="description">
  468. The style of stroked lines; used in conjunction with <tt>lineWidth</tt> to
  469. stroke the perimeter of the area. Unlike the Line mark type, the
  470. entire perimeter is stroked, rather than just one edge. The default value of
  471. this property is null, meaning areas are not stroked by default.
  472. <p>This property is <i>fixed</i> for non-segmented areas. See
  473. <a href="../symbols/pv.Mark.html">pv.Mark</a>.
  474. </div>
  475. <dl class="detailList">
  476. <dt class="heading">See:</dt>
  477. <dd><a href="../symbols/pv.html#.color">pv.color</a></dd>
  478. </dl>
  479. <hr />
  480. <a name="width"> </a>
  481. <div class="fixedFont">
  482. <span class="light">{number}</span>
  483. <b>width</b>
  484. </div>
  485. <div class="description">
  486. The width of a given span, in pixels; used for horizontal spans. If the width
  487. is specified, the height property should be 0 (the default). Either the top
  488. or bottom property should be used to space the spans vertically, typically as
  489. a multiple of the index.
  490. </div>
  491. <!-- ============================== method details ========================= -->
  492. <div class="sectionTitle">
  493. Method Detail
  494. </div>
  495. <a name="anchor"> </a>
  496. <div class="fixedFont">
  497. <span class="light">{<a href="../symbols/pv.Anchor.html">pv.Anchor</a>}</span>
  498. <b>anchor</b>(name)
  499. </div>
  500. <div class="description">
  501. Constructs a new area anchor with default properties. Areas support five
  502. different anchors:<ul>
  503. <li>top
  504. <li>left
  505. <li>center
  506. <li>bottom
  507. <li>right
  508. </ul>In addition to positioning properties (left, right, top bottom), the
  509. anchors support text rendering properties (text-align, text-baseline). Text is
  510. rendered to appear inside the area polygon.
  511. <p>To facilitate stacking of areas, the anchors are defined in terms of their
  512. opposite edge. For example, the top anchor defines the bottom property, such
  513. that the area grows upwards; the bottom anchor instead defines the top
  514. property, such that the area grows downwards. Of course, in general it is
  515. more robust to use panels and the cousin accessor to define stacked area
  516. marks; see <a href="../symbols/pv.Mark.html#scene">pv.Mark#scene</a> for an example.
  517. </div>
  518. <dl class="detailList">
  519. <dt class="heading">Parameters:</dt>
  520. <dt>
  521. <span class="light fixedFont">{string}</span> <b>name</b>
  522. </dt>
  523. <dd>the anchor name; either a string or a property function.</dd>
  524. </dl>
  525. <dl class="detailList">
  526. <dt class="heading">Returns:</dt>
  527. <dd><span class="light fixedFont">{<a href="../symbols/pv.Anchor.html">pv.Anchor</a>}</span> </dd>
  528. </dl>
  529. <!-- ============================== event details ========================= -->
  530. <hr />
  531. </div>
  532. <!-- ============================== footer ================================= -->
  533. <div class="fineprint" style="clear:both">
  534. Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Tue Oct 06 2009 09:59:02 GMT-0700 (PDT)
  535. </div>
  536. </body>
  537. </html>