# Wijmo_Xlsx.Iworkbooknote

## Content

<div class="content__tsd">
						<div style="display:flex;justify-content:space-between;align-items:center">
							<h1>
								IWorkbookNote Interface
							</h1>
						</div>
						<section class="tsd-comment">
							<div class="tsd-comment">
								<div class="lead">
									<p>Represents the Workbook Object Model note definition.</p>
								</div>
							</div>
						</section>
						<section class="tsd-hierarchy">
							<h3>Heirarchy</h3>
							<ul class="tsd-hierarchy">
								<li>
									<span class="target">IWorkbookNote</span>
								</li>
							</ul>
						</section>
						<section class="">
							<h3>Implemented by</h3>
							<ul class="tsd-hierarchy">
								<li><a href="../classes/wijmo_xlsx.workbooknote.html" class="tsd-signature-type">WorkbookNote</a></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>
												Properties
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-property tsd-parent-kind-interface"><a href="wijmo_xlsx.iworkbooknote.html#author" class="tsd-kind-icon">author</a></li>
											<li class="tsd-kind-property tsd-parent-kind-interface"><a href="wijmo_xlsx.iworkbooknote.html#height" class="tsd-kind-icon">height</a></li>
											<li class="tsd-kind-property tsd-parent-kind-interface"><a href="wijmo_xlsx.iworkbooknote.html#offsetx" class="tsd-kind-icon">offsetX</a></li>
											<li class="tsd-kind-property tsd-parent-kind-interface"><a href="wijmo_xlsx.iworkbooknote.html#offsety" class="tsd-kind-icon">offsetY</a></li>
											<li class="tsd-kind-property tsd-parent-kind-interface"><a href="wijmo_xlsx.iworkbooknote.html#text" class="tsd-kind-icon">text</a></li>
											<li class="tsd-kind-property tsd-parent-kind-interface"><a href="wijmo_xlsx.iworkbooknote.html#textruns" class="tsd-kind-icon">text<wbr>Runs</a></li>
											<li class="tsd-kind-property tsd-parent-kind-interface"><a href="wijmo_xlsx.iworkbooknote.html#visible" class="tsd-kind-icon">visible</a></li>
											<li class="tsd-kind-property tsd-parent-kind-interface"><a href="wijmo_xlsx.iworkbooknote.html#width" class="tsd-kind-icon">width</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">
								<a name="author" class="tsd-anchor"></a>
								<h3><span class="tsd-flag ts-flagOptional">Optional</span> author</h3>
								<div class="tsd-signature tsd-kind-icon">author<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets or sets the author of the note.
										The default value is <strong>undefined</strong>.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
								<a name="height" class="tsd-anchor"></a>
								<h3><span class="tsd-flag ts-flagOptional">Optional</span> height</h3>
								<div class="tsd-signature tsd-kind-icon">height<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 height of the note, in pixels.
										The default value is <strong>undefined</strong>, which causes to use the default height, 79 pixels.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
								<a name="offsetx" class="tsd-anchor"></a>
								<h3><span class="tsd-flag ts-flagOptional">Optional</span> offsetX</h3>
								<div class="tsd-signature tsd-kind-icon">offsetX<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 offset in the X coordinate relative to bottom-right corner of the cell, in pixels.
										The default value is <strong>undefined</strong>, which causes to use the default offset, 15 pixels.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
								<a name="offsety" class="tsd-anchor"></a>
								<h3><span class="tsd-flag ts-flagOptional">Optional</span> offsetY</h3>
								<div class="tsd-signature tsd-kind-icon">offsetY<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 offset in the Y coordinate relative to bottom-right corner of the cell, in pixels.
										The default value is <strong>undefined</strong>, which causes to use the default offset, 2 pixels if the cell is in the first row, 15 pixels otherwise.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
								<a name="text" class="tsd-anchor"></a>
								<h3><span class="tsd-flag ts-flagOptional">Optional</span> text</h3>
								<div class="tsd-signature tsd-kind-icon">text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets or sets the text of the note.
										The default value is <strong>undefined</strong>.</p>
									</div>
									<p>Note that on import both this and <a href="wijmo_xlsx.iworkbooknote.html#textruns">textRuns</a> properties are filled and this property contains a plain text version of the <a href="wijmo_xlsx.iworkbooknote.html#textruns">textRuns</a> content.
									On export <a href="wijmo_xlsx.iworkbooknote.html#textruns">textRuns</a> takes precedence over this property if both are set.</p>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
								<a name="textruns" class="tsd-anchor"></a>
								<h3><span class="tsd-flag ts-flagOptional">Optional</span> textRuns</h3>
								<div class="tsd-signature tsd-kind-icon">text<wbr>Runs<span class="tsd-signature-symbol">:</span> <a href="wijmo_xlsx.iworkbooktextrun.html" class="tsd-signature-type">IWorkbookTextRun</a><span class="tsd-signature-symbol">[]</span></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets or sets the text runs represent the rich text of the note.
										The default value is <strong>undefined</strong>.</p>
									</div>
									<p>Note that on import both this and <a href="wijmo_xlsx.iworkbooknote.html#text">text</a> properties are filled and <a href="wijmo_xlsx.iworkbooknote.html#text">text</a> contains a plain text version of the content of this property.
									On export this property takes precedence over <a href="wijmo_xlsx.iworkbooknote.html#text">text</a> if both are set.</p>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
								<a name="visible" class="tsd-anchor"></a>
								<h3><span class="tsd-flag ts-flagOptional">Optional</span> visible</h3>
								<div class="tsd-signature tsd-kind-icon">visible<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Indicates whether the note will be displayed when you open an .xlsx file or whether it will be displayed when your hover over the owner's cell.
										The default value is <strong>undefined</strong>, which means <strong>true</strong>.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
								<a name="width" class="tsd-anchor"></a>
								<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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 width of the note, in pixels.
										The default value is <strong>undefined</strong>, which causes to use the default width, 144 pixels.</p>
									</div>
								</div>
							</section>
						</section>
					</div>