---
layout: posts
title: Api - Star Class
---
<div class="container container-main toggle-visibilityprivate toggle-public">
<section class="tsd-panel tsd-hierarchy">
	<h3>Hierarchy</h3>
	<ul class="tsd-hierarchy">
		<li>
			<span class="target">Star</span>
		</li>
	</ul>
</section>
<section class="tsd-panel">
	<h3>Implements</h3>
	<ul class="tsd-hierarchy">
		<li><a href="../interfaces/makerjs.imodel.html" class="tsd-signature-type">IModel</a></li>
	</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
	<h2>Index</h2>
	<section class="tsd-panel tsd-index-panel">
		<div class="tsd-index-content">
			<section class="tsd-index-section ">
				<h3>Constructors</h3>
				<ul class="tsd-index-list">
					<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="makerjs.models.star.html#constructor" class="tsd-kind-icon">constructor</a></li>
				</ul>
			</section>
			<section class="tsd-index-section ">
				<h3>Properties</h3>
				<ul class="tsd-index-list">
					<li class="tsd-kind-property tsd-parent-kind-class"><a href="makerjs.models.star.html#paths" class="tsd-kind-icon">paths</a></li>
				</ul>
			</section>
			<section class="tsd-index-section ">
				<h3>Methods</h3>
				<ul class="tsd-index-list">
					<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="makerjs.models.star.html#innerradiusratio" class="tsd-kind-icon">Inner<wbr>Radius<wbr>Ratio</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>Star<span class="tsd-signature-symbol">(</span>numberOfPoints<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, outerRadius<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, innerRadius<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, skipPoints<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="makerjs.models.star.html" class="tsd-signature-type">Star</a></li>
		</ul>
		<ul class="tsd-descriptions">
			<li class="tsd-description">
				<aside class="tsd-sources">
					<ul>
						<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/models/Star.ts#L5">src/maker.js/packages/maker.js/src/models/Star.ts:5</a></li>
					</ul>
				</aside>
				<h4 class="tsd-parameters-title">Parameters</h4>
				<ul class="tsd-parameters">
					<li>
						<h5>numberOfPoints: <span class="tsd-signature-type">number</span></h5>
					</li>
					<li>
						<h5>outerRadius: <span class="tsd-signature-type">number</span></h5>
					</li>
					<li>
						<h5><span class="tsd-flag ts-flagOptional">Optional</span> innerRadius: <span class="tsd-signature-type">number</span></h5>
					</li>
					<li>
						<h5><span class="tsd-flag ts-flagDefault value">Default value</span> skipPoints: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></h5>
					</li>
				</ul>
				<h4 class="tsd-returns-title">Returns <a href="makerjs.models.star.html" class="tsd-signature-type">Star</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="paths" class="tsd-anchor"></a>
		<h3>paths</h3>
		<div class="tsd-signature tsd-kind-icon">paths<span class="tsd-signature-symbol">:</span> <a href="../interfaces/makerjs.ipathmap.html" class="tsd-signature-type">IPathMap</a></div>
		<aside class="tsd-sources">
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/models/Star.ts#L5">src/maker.js/packages/maker.js/src/models/Star.ts:5</a></li>
			</ul>
		</aside>
	</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-static">
		<a name="innerradiusratio" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagStatic">Static</span> Inner<wbr>Radius<wbr>Ratio</h3>
		<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
			<li class="tsd-signature tsd-kind-icon">Inner<wbr>Radius<wbr>Ratio<span class="tsd-signature-symbol">(</span>numberOfPoints<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, skipPoints<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><span class="tsd-signature-type">number</span></li>
		</ul>
		<ul class="tsd-descriptions">
			<li class="tsd-description">
				<aside class="tsd-sources">
					<ul>
						<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/models/Star.ts#L30">src/maker.js/packages/maker.js/src/models/Star.ts:30</a></li>
					</ul>
				</aside>
				<h4 class="tsd-parameters-title">Parameters</h4>
				<ul class="tsd-parameters">
					<li>
						<h5>numberOfPoints: <span class="tsd-signature-type">number</span></h5>
					</li>
					<li>
						<h5>skipPoints: <span class="tsd-signature-type">number</span></h5>
					</li>
				</ul>
				<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
			</li>
		</ul>
	</section>
</section>
</div>
<footer class="tsd-panel with-border-bottom">
<div class="container">
	<h2>Legend</h2>
	<div class="tsd-legend-group">
		<ul class="tsd-legend">
			<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
			<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
			<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
			<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
			<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
			<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
			<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
		</ul>
		<ul class="tsd-legend">
			<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
			<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
			<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
			<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
		</ul>
		<ul class="tsd-legend">
			<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
			<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
			<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
			<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
			<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
			<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
		</ul>
		<ul class="tsd-legend">
			<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
			<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
			<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
			<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
			<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
			<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
			<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
		</ul>
		<ul class="tsd-legend">
			<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
			<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
			<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
			<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
		</ul>
		<ul class="tsd-legend">
			<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
			<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
			<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
		</ul>
		<ul class="tsd-legend">
			<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
			<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
			<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
		</ul>
		<ul class="tsd-legend">
			<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
			<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
		</ul>
	</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.io" target="_blank">TypeDoc</a></p>
</div>