<div class="header-panel member">
<h2><span class="identifier">PdfPen</span> Class</h2>
<dl class="dl-horizontal">
<dt>File</dt><dd class="filename">wijmo.pdf.js</dd>
<dt>Module</dt><dd><a href="topic/wijmo.pdf.Module.html"><span class="identifier">wijmo.pdf</span></a></dd>
</dl>
<div class="comment"><p>Determines an object used to stroke paths and text.</p></div>
</div>
<div class="member-panel class members" ng-class="{ 'show-inherited' : ctx.showInherited, 'show-raisers' : ctx.showRaisers }">
<h3 class="node">Constructor</h3>
<ul>
<li class="mmethod"><a href="topic/wijmo.pdf.PdfPen.Class.html/#constructor">constructor</a></li>
</ul>
<h3 class="node">Properties</h3>
<ul>
<li class="mproperty"><a href="topic/wijmo.pdf.PdfPen.Class.html/#brush">brush</a></li>
<li class="mproperty"><a href="topic/wijmo.pdf.PdfPen.Class.html/#cap">cap</a></li>
<li class="mproperty"><a href="topic/wijmo.pdf.PdfPen.Class.html/#color">color</a></li>
<li class="mproperty"><a href="topic/wijmo.pdf.PdfPen.Class.html/#dashPattern">dashPattern</a></li>
<li class="mproperty"><a href="topic/wijmo.pdf.PdfPen.Class.html/#join">join</a></li>
<li class="mproperty"><a href="topic/wijmo.pdf.PdfPen.Class.html/#miterLimit">miterLimit</a></li>
<li class="mproperty"><a href="topic/wijmo.pdf.PdfPen.Class.html/#width">width</a></li>
</ul>
<h3 class="node">Methods</h3>
<ul>
<li class="mmethod"><a href="topic/wijmo.pdf.PdfPen.Class.html/#clone">clone</a></li>
<li class="mmethod"><a href="topic/wijmo.pdf.PdfPen.Class.html/#equals">equals</a></li>
</ul>
</div>
<h3>Constructor</h3>
<div id="constructor" class="member-panel mmethod">
<h3>constructor</h3>
<pre>constructor(colorOrBrushOrOptions?: <span class="identifier">any</span>, width?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a>, dashPattern?: <a href="topic/wijmo.pdf.PdfDashPattern.Class.html"><span class="identifier">PdfDashPattern</span></a>, cap?: <a href="topic/wijmo.pdf.PdfLineCapStyle.Enum.html"><span class="identifier">PdfLineCapStyle</span></a>, join?: <a href="topic/wijmo.pdf.PdfLineJoinStyle.Enum.html"><span class="identifier">PdfLineJoinStyle</span></a>, miterLimit?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a>): <a href="topic/wijmo.pdf.PdfPen.Class.html"><span class="identifier">PdfPen</span></a></pre>
<div class="comment"><p>Initializes a new instance of the <a href="topic/wijmo.pdf.PdfPen.Class.html"><span class="identifier">PdfPen</span></a> class with the specified color or
brush or JavaScript object.</p>
<p>The first argument can accept the following values:
<ul>
 <li><a href="topic/wijmo.Color.Class.html"><span class="identifier">Color</span></a> object or any string acceptable by the <a href="topic/wijmo.Color.Class.html/#fromString"><span class="identifier">fromString</span></a> method.</li>
 <li><a href="topic/wijmo.pdf.PdfBrush.Class.html"><span class="identifier">PdfBrush</span></a> object.</li>
 <li>JavaScript object containing initialization properties (all other arguments are ignored).</li>
</ul></p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>colorOrBrushOrOptions</b>: <span class="identifier">any</span> <span class="badge">Optional</span><br/><p>The color or brush or JavaScript object to use.</p></li><li><b>width</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a> <span class="badge">Optional</span><br/><p>The width to use.</p></li><li><b>dashPattern</b>: <a href="topic/wijmo.pdf.PdfDashPattern.Class.html"><span class="identifier">PdfDashPattern</span></a> <span class="badge">Optional</span><br/><p>The dash pattern to use.</p></li><li><b>cap</b>: <a href="topic/wijmo.pdf.PdfLineCapStyle.Enum.html"><span class="identifier">PdfLineCapStyle</span></a> <span class="badge">Optional</span><br/><p>The line cap style to use.</p></li><li><b>join</b>: <a href="topic/wijmo.pdf.PdfLineJoinStyle.Enum.html"><span class="identifier">PdfLineJoinStyle</span></a> <span class="badge">Optional</span><br/><p>The line join style to use.</p></li><li><b>miterLimit</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a> <span class="badge">Optional</span><br/><p>The miter limit to use.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><a href="topic/wijmo.pdf.PdfPen.Class.html"><span class="identifier">PdfPen</span></a></dd>
</dl>
</div>
<h3 class="node">Properties</h3>
<div class="member-list" ng-class="{ 'show-inherited' : ctx.showInherited, 'show-raisers' : ctx.showRaisers }">
<div id="brush" class="member-panel mproperty">
<h3>brush</h3>
<div class="comment"><p>Gets or sets the brush used to stroke paths.
Takes precedence over the <a href="topic/wijmo.pdf.PdfPen.Class.html/#color"><span class="identifier">color</span></a> property, if defined.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.pdf.PdfBrush.Class.html"><span class="identifier">PdfBrush</span></a></dd>
</dl>
</div>
<div id="cap" class="member-panel mproperty">
<h3>cap</h3>
<div class="comment"><p>Gets or sets the shape that shall be used at the open ends of a stroked path.
The default value is <b>Butt</b>.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.pdf.PdfLineCapStyle.Enum.html"><span class="identifier">PdfLineCapStyle</span></a></dd>
</dl>
</div>
<div id="color" class="member-panel mproperty">
<h3>color</h3>
<div class="comment"><p>Gets or sets the color used to stroke paths.
The default color is black.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.Color.Class.html"><span class="identifier">Color</span></a></dd>
</dl>
</div>
<div id="dashPattern" class="member-panel mproperty">
<h3>dashPattern</h3>
<div class="comment"><p>Gets the dash pattern used to stroke paths.
The default value is a solid line.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.pdf.PdfDashPattern.Class.html"><span class="identifier">PdfDashPattern</span></a></dd>
</dl>
</div>
<div id="join" class="member-panel mproperty">
<h3>join</h3>
<div class="comment"><p>Gets or sets the shape to be used at the corners of a stroked path.
The default value is <b>Miter</b>.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.pdf.PdfLineJoinStyle.Enum.html"><span class="identifier">PdfLineJoinStyle</span></a></dd>
</dl>
</div>
<div id="miterLimit" class="member-panel mproperty">
<h3>miterLimit</h3>
<div class="comment"><p>Determines the maximum value of the miter length to the line width ratio, when the line
join is converted from miter to bevel.
The default value is 10.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></dd>
</dl>
</div>
<div id="width" class="member-panel mproperty">
<h3>width</h3>
<div class="comment"><p>Gets or sets the line width used to stroke paths, in points.
The default width is 1.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></dd>
</dl>
</div>
</div>
<h3 class="node">Methods</h3>
<div class="member-list" ng-class="{ 'show-inherited' : ctx.showInherited, 'show-raisers' : ctx.showRaisers }">
<div id="clone" class="member-panel mmethod">
<h3>clone</h3>
<pre>clone(): <a href="topic/wijmo.pdf.PdfPen.Class.html"><span class="identifier">PdfPen</span></a></pre>
<div class="comment"><p>Creates a copy of this <a href="topic/wijmo.pdf.PdfPen.Class.html"><span class="identifier">PdfPen</span></a>.</p></div>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><a href="topic/wijmo.pdf.PdfPen.Class.html"><span class="identifier">PdfPen</span></a></dd>
</dl>
</div>
<div id="equals" class="member-panel mmethod">
<h3>equals</h3>
<pre>equals(value: <a href="topic/wijmo.pdf.PdfPen.Class.html"><span class="identifier">PdfPen</span></a>): <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></pre>
<div class="comment"><p>Determines whether the specified <a href="topic/wijmo.pdf.PdfPen.Class.html"><span class="identifier">PdfPen</span></a> instance is equal to the current one.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>value</b>: <a href="topic/wijmo.pdf.PdfPen.Class.html"><span class="identifier">PdfPen</span></a><br/><p><a href="topic/wijmo.pdf.PdfPen.Class.html"><span class="identifier">PdfPen</span></a> to compare.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></dd>
</dl>
</div>
</div>
