---
layout: posts
title: Api - IBoundingHex Interface
---
<div class="container container-main toggle-visibilityprivate toggle-public">
<section class="tsd-panel tsd-comment">
	<div class="tsd-comment tsd-typography">
		<div class="lead">
			<p>A hexagon which surrounds a model.</p>
		</div>
	</div>
</section>
<section class="tsd-panel tsd-hierarchy">
	<h3>Hierarchy</h3>
	<ul class="tsd-hierarchy">
		<li>
			<a href="makerjs.imodel.html" class="tsd-signature-type">IModel</a>
			<ul class="tsd-hierarchy">
				<li>
					<span class="target">IBoundingHex</span>
				</li>
			</ul>
		</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>Properties</h3>
				<ul class="tsd-index-list">
					<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="makerjs.iboundinghex.html#caption" class="tsd-kind-icon">caption</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="makerjs.iboundinghex.html#exporteroptions" class="tsd-kind-icon">exporter<wbr>Options</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="makerjs.iboundinghex.html#layer" class="tsd-kind-icon">layer</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="makerjs.iboundinghex.html#models" class="tsd-kind-icon">models</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="makerjs.iboundinghex.html#notes" class="tsd-kind-icon">notes</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="makerjs.iboundinghex.html#origin" class="tsd-kind-icon">origin</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="makerjs.iboundinghex.html#paths" class="tsd-kind-icon">paths</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface"><a href="makerjs.iboundinghex.html#radius" class="tsd-kind-icon">radius</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="makerjs.iboundinghex.html#type" class="tsd-kind-icon">type</a></li>
					<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="makerjs.iboundinghex.html#units" class="tsd-kind-icon">units</a></li>
				</ul>
			</section>
		</div>
	</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-interface tsd-is-inherited">
		<a name="caption" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagOptional">Optional</span> caption</h3>
		<div class="tsd-signature tsd-kind-icon">caption<span class="tsd-signature-symbol">:</span> <a href="makerjs.icaption.html" class="tsd-signature-type">ICaption</a></div>
		<aside class="tsd-sources">
			<p>Inherited from <a href="makerjs.iboundinghex.html">IBoundingHex</a>.<a href="makerjs.iboundinghex.html#caption">caption</a></p>
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/schema.ts#L232">src/maker.js/packages/maker.js/src/core/schema.ts:232</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Optional Caption object.</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
		<a name="exporteroptions" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagOptional">Optional</span> exporter<wbr>Options</h3>
		<div class="tsd-signature tsd-kind-icon">exporter<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
		<aside class="tsd-sources">
			<p>Inherited from <a href="makerjs.iboundinghex.html">IBoundingHex</a>.<a href="makerjs.iboundinghex.html#exporteroptions">exporterOptions</a></p>
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/schema.ts#L237">src/maker.js/packages/maker.js/src/core/schema.ts:237</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Optional exporter options for this model.</p>
			</div>
		</div>
		<div class="tsd-type-declaration">
			<h4>Type declaration</h4>
			<ul class="tsd-parameters">
				<li class="tsd-parameter-index-signature">
					<h5><span class="tsd-signature-symbol">[</span>exporterName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
				</li>
			</ul>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
		<a name="layer" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagOptional">Optional</span> layer</h3>
		<div class="tsd-signature tsd-kind-icon">layer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
		<aside class="tsd-sources">
			<p>Inherited from <a href="makerjs.iboundinghex.html">IBoundingHex</a>.<a href="makerjs.iboundinghex.html#layer">layer</a></p>
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/schema.ts#L227">src/maker.js/packages/maker.js/src/core/schema.ts:227</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Optional layer of this model.</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
		<a name="models" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagOptional">Optional</span> models</h3>
		<div class="tsd-signature tsd-kind-icon">models<span class="tsd-signature-symbol">:</span> <a href="makerjs.imodelmap.html" class="tsd-signature-type">IModelMap</a></div>
		<aside class="tsd-sources">
			<p>Inherited from <a href="makerjs.iboundinghex.html">IBoundingHex</a>.<a href="makerjs.iboundinghex.html#models">models</a></p>
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/schema.ts#L212">src/maker.js/packages/maker.js/src/core/schema.ts:212</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Optional map of models within this model.</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
		<a name="notes" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagOptional">Optional</span> notes</h3>
		<div class="tsd-signature tsd-kind-icon">notes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
		<aside class="tsd-sources">
			<p>Inherited from <a href="makerjs.iboundinghex.html">IBoundingHex</a>.<a href="makerjs.iboundinghex.html#notes">notes</a></p>
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/schema.ts#L222">src/maker.js/packages/maker.js/src/core/schema.ts:222</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>An author may wish to add notes to this model instance.</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
		<a name="origin" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagOptional">Optional</span> origin</h3>
		<div class="tsd-signature tsd-kind-icon">origin<span class="tsd-signature-symbol">:</span> <a href="makerjs.ipoint.html" class="tsd-signature-type">IPoint</a></div>
		<aside class="tsd-sources">
			<p>Inherited from <a href="makerjs.iboundinghex.html">IBoundingHex</a>.<a href="makerjs.iboundinghex.html#origin">origin</a></p>
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/schema.ts#L197">src/maker.js/packages/maker.js/src/core/schema.ts:197</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Optional origin location of this model.</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
		<a name="paths" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagOptional">Optional</span> paths</h3>
		<div class="tsd-signature tsd-kind-icon">paths<span class="tsd-signature-symbol">:</span> <a href="makerjs.ipathmap.html" class="tsd-signature-type">IPathMap</a></div>
		<aside class="tsd-sources">
			<p>Inherited from <a href="makerjs.iboundinghex.html">IBoundingHex</a>.<a href="makerjs.iboundinghex.html#paths">paths</a></p>
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/schema.ts#L207">src/maker.js/packages/maker.js/src/core/schema.ts:207</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Optional map of path objects in this model.</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
		<a name="radius" class="tsd-anchor"></a>
		<h3>radius</h3>
		<div class="tsd-signature tsd-kind-icon">radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
		<aside class="tsd-sources">
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/maker.ts#L827">src/maker.js/packages/maker.js/src/core/maker.ts:827</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Radius of the hexagon, which is also the length of a side.</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
		<a name="type" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
		<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
		<aside class="tsd-sources">
			<p>Inherited from <a href="makerjs.iboundinghex.html">IBoundingHex</a>.<a href="makerjs.iboundinghex.html#type">type</a></p>
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/schema.ts#L202">src/maker.js/packages/maker.js/src/core/schema.ts:202</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>A model may want to specify its type, but this value is not employed yet.</p>
			</div>
		</div>
	</section>
	<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
		<a name="units" class="tsd-anchor"></a>
		<h3><span class="tsd-flag ts-flagOptional">Optional</span> units</h3>
		<div class="tsd-signature tsd-kind-icon">units<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
		<aside class="tsd-sources">
			<p>Inherited from <a href="makerjs.iboundinghex.html">IBoundingHex</a>.<a href="makerjs.iboundinghex.html#units">units</a></p>
			<ul>
				<li>Defined in <a href="https://github.com/microsoft/maker.js/blob/master/packages/maker.js/src/core/schema.ts#L217">src/maker.js/packages/maker.js/src/core/schema.ts:217</a></li>
			</ul>
		</aside>
		<div class="tsd-comment tsd-typography">
			<div class="lead">
				<p>Optional unit system of this model. See UnitType for possible values.</p>
			</div>
		</div>
	</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>