# PdfPen Class

## Content

<div class="content__tsd">
						<div style="display:flex;justify-content:space-between;align-items:center">
							<h1>
								PdfPen Class
							</h1>
						</div>
						<section class="tsd-comment">
							<div class="tsd-comment">
								<div class="lead">
									<p>Determines an object used to stroke paths and text.</p>
								</div>
							</div>
						</section>
						<section class="tsd-hierarchy">
							<h3>Heirarchy</h3>
							<ul class="tsd-hierarchy">
								<li>
									<span class="target">PdfPen</span>
								</li>
							</ul>
						</section>
						<section class="tsd-index-group">
							<section class="tsd-index-panel">
								<div class="tsd-index-content">
									<section class="tsd-index-section ">
										<div class="title">
											<div class="gc_api_tree-item_icon_img_wrapper">
												<div class="gc_api_tree-item_icon_img" data-expand="true">
												</div>
											</div>
											<h3>
												Constructors
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="wijmo_pdf.pdfpen.html#constructor" class="tsd-kind-icon">constructor</a></li>
										</ul>
									</section>
									<section class="tsd-index-section ">
										<div class="title">
											<div class="gc_api_tree-item_icon_img_wrapper">
												<div class="gc_api_tree-item_icon_img" data-expand="true">
												</div>
											</div>
											<h3>
												Properties
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_pdf.pdfpen.html#brush" class="tsd-kind-icon">brush</a></li>
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_pdf.pdfpen.html#cap" class="tsd-kind-icon">cap</a></li>
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_pdf.pdfpen.html#color" class="tsd-kind-icon">color</a></li>
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_pdf.pdfpen.html#dashpattern" class="tsd-kind-icon">dash<wbr>Pattern</a></li>
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_pdf.pdfpen.html#join" class="tsd-kind-icon">join</a></li>
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_pdf.pdfpen.html#miterlimit" class="tsd-kind-icon">miter<wbr>Limit</a></li>
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_pdf.pdfpen.html#width" class="tsd-kind-icon">width</a></li>
										</ul>
									</section>
									<section class="tsd-index-section ">
										<div class="title">
											<div class="gc_api_tree-item_icon_img_wrapper">
												<div class="gc_api_tree-item_icon_img" data-expand="true">
												</div>
											</div>
											<h3>
												Methods
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-method tsd-parent-kind-class"><a href="wijmo_pdf.pdfpen.html#clone" class="tsd-kind-icon">clone</a></li>
											<li class="tsd-kind-method tsd-parent-kind-class"><a href="wijmo_pdf.pdfpen.html#equals" class="tsd-kind-icon">equals</a></li>
										</ul>
									</section>
								</div>
							</section>
						</section>
						<section class="tsd-panel-group tsd-member-group ">
							<h2>Constructors</h2>
							<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
								<a name="constructor" class="tsd-anchor"></a>
								<h3>constructor</h3>
								<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
									<li class="tsd-signature tsd-kind-icon">new <wbr>Pdf<wbr>Pen<span class="tsd-signature-symbol">(</span>colorOrBrushOrOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, dashPattern<span class="tsd-signature-symbol">?: </span><a href="wijmo_pdf.pdfdashpattern.html" class="tsd-signature-type">PdfDashPattern</a>, cap<span class="tsd-signature-symbol">?: </span><a href="../enums/wijmo_pdf.pdflinecapstyle.html" class="tsd-signature-type">PdfLineCapStyle</a>, join<span class="tsd-signature-symbol">?: </span><a href="../enums/wijmo_pdf.pdflinejoinstyle.html" class="tsd-signature-type">PdfLineJoinStyle</a>, miterLimit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="wijmo_pdf.pdfpen.html" class="tsd-signature-type">PdfPen</a></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<aside class="tsd-sources">
										</aside>
										<div class="tsd-comment">
											<div class="lead">
												<p>Initializes a new instance of the <a href="wijmo_pdf.pdfpen.html">PdfPen</a> class with the specified color or
												brush or JavaScript object.</p>
											</div>
											<p>The first argument can accept the following values:</p>
											<ul>
												<li><a href="wijmo.color.html">wijmo.Color</a> object or any string acceptable by the <a href="wijmo.color.html#fromstring">wijmo.Color.fromString</a> method.</li>
												<li><a href="wijmo_pdf.pdfbrush.html">PdfBrush</a> object.</li>
												<li>JavaScript object containing initialization properties (all other arguments are ignored).</li>
											</ul>
										</div>
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5><span class="tsd-flag ts-flagOptional">Optional</span> colorOrBrushOrOptions: <span class="tsd-signature-type">any</span></h5>
												<div class="tsd-comment">
													<div class="lead">
														<p>The color or brush or JavaScript object to use.</p>
													</div>
												</div>
											</li>
											<li>
												<h5><span class="tsd-flag ts-flagOptional">Optional</span> width: <span class="tsd-signature-type">number</span></h5>
												<div class="tsd-comment">
													<div class="lead">
														<p>The width to use.</p>
													</div>
												</div>
											</li>
											<li>
												<h5><span class="tsd-flag ts-flagOptional">Optional</span> dashPattern: <a href="wijmo_pdf.pdfdashpattern.html" class="tsd-signature-type">PdfDashPattern</a></h5>
												<div class="tsd-comment">
													<div class="lead">
														<p>The dash pattern to use.</p>
													</div>
												</div>
											</li>
											<li>
												<h5><span class="tsd-flag ts-flagOptional">Optional</span> cap: <a href="../enums/wijmo_pdf.pdflinecapstyle.html" class="tsd-signature-type">PdfLineCapStyle</a></h5>
												<div class="tsd-comment">
													<div class="lead">
														<p>The line cap style to use.</p>
													</div>
												</div>
											</li>
											<li>
												<h5><span class="tsd-flag ts-flagOptional">Optional</span> join: <a href="../enums/wijmo_pdf.pdflinejoinstyle.html" class="tsd-signature-type">PdfLineJoinStyle</a></h5>
												<div class="tsd-comment">
													<div class="lead">
														<p>The line join style to use.</p>
													</div>
												</div>
											</li>
											<li>
												<h5><span class="tsd-flag ts-flagOptional">Optional</span> miterLimit: <span class="tsd-signature-type">number</span></h5>
												<div class="tsd-comment">
													<div class="lead">
														<p>The miter limit to use.</p>
													</div>
												</div>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <a href="wijmo_pdf.pdfpen.html" class="tsd-signature-type">PdfPen</a></h4>
									</li>
								</ul>
							</section>
						</section>
						<section class="tsd-panel-group tsd-member-group ">
							<h2>Properties</h2>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="brush" class="tsd-anchor"></a>
								<h3>brush</h3>
								<div class="tsd-signature tsd-kind-icon">brush<span class="tsd-signature-symbol">:</span> <a href="wijmo_pdf.pdfbrush.html" class="tsd-signature-type">PdfBrush</a></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets or sets the brush used to stroke paths.
										Takes precedence over the <a href="wijmo_pdf.pdfpen.html#color">color</a> property, if defined.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="cap" class="tsd-anchor"></a>
								<h3>cap</h3>
								<div class="tsd-signature tsd-kind-icon">cap<span class="tsd-signature-symbol">:</span> <a href="../enums/wijmo_pdf.pdflinecapstyle.html" class="tsd-signature-type">PdfLineCapStyle</a></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<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>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="color" class="tsd-anchor"></a>
								<h3>color</h3>
								<div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <a href="wijmo.color.html" class="tsd-signature-type">Color</a></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets or sets the color used to stroke paths.
										The default color is black.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="dashpattern" class="tsd-anchor"></a>
								<h3>dashPattern</h3>
								<div class="tsd-signature tsd-kind-icon">dash<wbr>Pattern<span class="tsd-signature-symbol">:</span> <a href="wijmo_pdf.pdfdashpattern.html" class="tsd-signature-type">PdfDashPattern</a></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets the dash pattern used to stroke paths.
										The default value is a solid line.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="join" class="tsd-anchor"></a>
								<h3>join</h3>
								<div class="tsd-signature tsd-kind-icon">join<span class="tsd-signature-symbol">:</span> <a href="../enums/wijmo_pdf.pdflinejoinstyle.html" class="tsd-signature-type">PdfLineJoinStyle</a></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<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>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="miterlimit" class="tsd-anchor"></a>
								<h3>miterLimit</h3>
								<div class="tsd-signature tsd-kind-icon">miter<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<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>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="width" class="tsd-anchor"></a>
								<h3>width</h3>
								<div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets or sets the line width used to stroke paths, in points.
										The default width is 1.</p>
									</div>
								</div>
							</section>
						</section>
						<section class="tsd-panel-group tsd-member-group ">
							<h2>Methods</h2>
							<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
								<a name="clone" class="tsd-anchor"></a>
								<h3>clone</h3>
								<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
									<li class="tsd-signature tsd-kind-icon">clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="wijmo_pdf.pdfpen.html" class="tsd-signature-type">PdfPen</a></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<aside class="tsd-sources">
										</aside>
										<div class="tsd-comment">
											<div class="lead">
												<p>Creates a copy of this <a href="wijmo_pdf.pdfpen.html">PdfPen</a>.</p>
											</div>
										</div>
										<h4 class="tsd-returns-title">Returns <a href="wijmo_pdf.pdfpen.html" class="tsd-signature-type">PdfPen</a></h4>
										<p>A copy of this pen.</p>
									</li>
								</ul>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
								<a name="equals" class="tsd-anchor"></a>
								<h3>equals</h3>
								<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
									<li class="tsd-signature tsd-kind-icon">equals<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="wijmo_pdf.pdfpen.html" class="tsd-signature-type">PdfPen</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<aside class="tsd-sources">
										</aside>
										<div class="tsd-comment">
											<div class="lead">
												<p>Determines whether the specified <a href="wijmo_pdf.pdfpen.html">PdfPen</a> instance is equal to the current one.</p>
											</div>
										</div>
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>value: <a href="wijmo_pdf.pdfpen.html" class="tsd-signature-type">PdfPen</a></h5>
												<div class="tsd-comment">
													<p><a href="wijmo_pdf.pdfpen.html">PdfPen</a> to compare.</p>
												</div>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
										<p>true if the specified object is equal to the current one, otherwise false.</p>
									</li>
								</ul>
							</section>
						</section>
					</div>