# PdfGradientBrush Class

## Content

<div class="content__tsd">
						<div style="display:flex;justify-content:space-between;align-items:center">
							<h1>
								PdfGradientBrush Class
							</h1>
						</div>
						<section class="tsd-comment">
							<div class="tsd-comment">
								<div class="lead">
									<p>Represents an abstract class that serves as a base class for the
									<a href="wijmo_pdf.pdflineargradientbrush.html">PdfLinearGradientBrush</a> and <a href="wijmo_pdf.pdfradialgradientbrush.html">PdfRadialGradientBrush</a> classes.</p>
								</div>
								<p>This class is not intended to be instantiated in your code.</p>
							</div>
						</section>
						<section class="tsd-hierarchy">
							<h3>Heirarchy</h3>
							<ul class="tsd-hierarchy">
								<li>
									<a href="wijmo_pdf.pdfbrush.html" class="tsd-signature-type">PdfBrush</a>
									<ul class="tsd-hierarchy">
										<li>
											<span class="target">PdfGradientBrush</span>
											<ul class="tsd-hierarchy">
												<li>
													<a href="wijmo_pdf.pdfradialgradientbrush.html" class="tsd-signature-type">PdfRadialGradientBrush</a>
												</li>
												<li>
													<a href="wijmo_pdf.pdflineargradientbrush.html" class="tsd-signature-type">PdfLinearGradientBrush</a>
												</li>
											</ul>
										</li>
									</ul>
								</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.pdfgradientbrush.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.pdfgradientbrush.html#opacity" class="tsd-kind-icon">opacity</a></li>
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_pdf.pdfgradientbrush.html#stops" class="tsd-kind-icon">stops</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 tsd-is-inherited"><a href="wijmo_pdf.pdfgradientbrush.html#clone" class="tsd-kind-icon">clone</a></li>
											<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="wijmo_pdf.pdfgradientbrush.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>Gradient<wbr>Brush<span class="tsd-signature-symbol">(</span>stops<span class="tsd-signature-symbol">?: </span><a href="wijmo_pdf.pdfgradientstop.html" class="tsd-signature-type">PdfGradientStop</a><span class="tsd-signature-symbol">[]</span>, opacity<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.pdfgradientbrush.html" class="tsd-signature-type">PdfGradientBrush</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.pdfgradientbrush.html">PdfGradientBrush</a> class.</p>
											</div>
										</div>
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5><span class="tsd-flag ts-flagOptional">Optional</span> stops: <a href="wijmo_pdf.pdfgradientstop.html" class="tsd-signature-type">PdfGradientStop</a><span class="tsd-signature-symbol">[]</span></h5>
												<div class="tsd-comment">
													<div class="lead">
														<p>The <a href="wijmo_pdf.pdfgradientstop.html">PdfGradientStop</a> array to set on this brush.</p>
													</div>
												</div>
											</li>
											<li>
												<h5><span class="tsd-flag ts-flagOptional">Optional</span> opacity: <span class="tsd-signature-type">number</span></h5>
												<div class="tsd-comment">
													<div class="lead">
														<p>The opacity of this brush.</p>
													</div>
												</div>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <a href="wijmo_pdf.pdfgradientbrush.html" class="tsd-signature-type">PdfGradientBrush</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="opacity" class="tsd-anchor"></a>
								<h3>opacity</h3>
								<div class="tsd-signature tsd-kind-icon">opacity<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 opacity of the brush.
											The value must be in range [0, 1], where 0 indicates that the brush is
											completely transparent and 1 indicates that the brush is completely opaque.
										The default value is 1.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="stops" class="tsd-anchor"></a>
								<h3>stops</h3>
								<div class="tsd-signature tsd-kind-icon">stops<span class="tsd-signature-symbol">:</span> <a href="wijmo_pdf.pdfgradientstop.html" class="tsd-signature-type">PdfGradientStop</a><span class="tsd-signature-symbol">[]</span></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets or sets an array of <a href="wijmo_pdf.pdfgradientstop.html">PdfGradientStop</a> objects representing a color,
											offset and opacity within the brush's gradient axis.
										The default value is an empty array.</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 tsd-is-inherited">
								<a name="clone" class="tsd-anchor"></a>
								<h3>clone</h3>
								<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
									<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.pdfbrush.html" class="tsd-signature-type">PdfBrush</a></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<aside class="tsd-sources">
											<p>Inherited from <a href="wijmo_pdf.pdfbrush.html">PdfBrush</a>.<a href="wijmo_pdf.pdfbrush.html#clone">clone</a></p>
										</aside>
										<div class="tsd-comment">
											<div class="lead">
												<p>Creates a copy of this <a href="wijmo_pdf.pdfbrush.html">PdfBrush</a>.</p>
											</div>
										</div>
										<h4 class="tsd-returns-title">Returns <a href="wijmo_pdf.pdfbrush.html" class="tsd-signature-type">PdfBrush</a></h4>
										<p>A copy of this brush.</p>
									</li>
								</ul>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
								<a name="equals" class="tsd-anchor"></a>
								<h3>equals</h3>
								<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
									<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.pdfgradientbrush.html" class="tsd-signature-type">PdfGradientBrush</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">
											<p>Overrides <a href="wijmo_pdf.pdfbrush.html">PdfBrush</a>.<a href="wijmo_pdf.pdfbrush.html#equals">equals</a></p>
										</aside>
										<div class="tsd-comment">
											<div class="lead">
												<p>Determines whether the specified <a href="wijmo_pdf.pdfgradientbrush.html">PdfGradientBrush</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.pdfgradientbrush.html" class="tsd-signature-type">PdfGradientBrush</a></h5>
												<div class="tsd-comment">
													<p><a href="wijmo_pdf.pdfgradientbrush.html">PdfGradientBrush</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>