docs: update docs

This commit is contained in:
StevanFreeborn authored and GitHub Actions committed 2024-07-19 04:16:56 +00:00
1 parent 2a67ead01a
commit d99d00e450
71 files changed
+411 -414

No files matched your search

+2 -2
View File
@@ -157,7 +157,7 @@
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="ListField.html">ListField</a></li></ul><h1>Class ListField</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ListField - Represents a list field.</p>
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ListField">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><ul class="tsd-hierarchy"><li><span class="target">ListField</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ListField.ts#L10">models/ListField.ts:10</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="ListField.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ListField">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><ul class="tsd-hierarchy"><li><span class="target">ListField</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/ListField.ts:10</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="ListField.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ListField.html#appId" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a>
<a href="ListField.html#id" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
<a href="ListField.html#isRequired" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Required</span></a>
@@ -181,7 +181,7 @@
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ListField.html" class="tsd-signature-type tsd-kind-class">ListField</a></h4><ul>
<li>A new ListField.</li>
</ul>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="Field.html">Field</a>.<a href="Field.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ListField.ts#L40">models/ListField.ts:40</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">app<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#appId">appId</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L16">models/Field.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L11">models/Field.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Required</span><a href="#isRequired" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isRequired">isRequired</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L36">models/Field.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unique</span><a href="#isUnique" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Unique</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isUnique">isUnique</a></p><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/Field.ts#L41">models/Field.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="listId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Id</span><a href="#listId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">list<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/blob/90a559a/src/models/ListField.ts#L19">models/ListField.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="multiplicity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>multiplicity</span><a href="#multiplicity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">multiplicity</span><span class="tsd-signature-symbol">:</span> <a href="../enums/Multiplicity.html" class="tsd-signature-type tsd-kind-enum">Multiplicity</a></div><div class="tsd-comment tsd-typography"></div><aside claLine truncated
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="Field.html">Field</a>.<a href="Field.html#constructor">constructor</a></p><ul><li>Defined in models/ListField.ts:40</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">app<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#appId">appId</a></p><ul><li>Defined in models/Field.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#id">id</a></p><ul><li>Defined in models/Field.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Required</span><a href="#isRequired" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isRequired">isRequired</a></p><ul><li>Defined in models/Field.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unique</span><a href="#isUnique" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Unique</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#isUnique">isUnique</a></p><ul><li>Defined in models/Field.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="listId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Id</span><a href="#listId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">list<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ListField.ts:19</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="multiplicity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>multiplicity</span><a href="#multiplicity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">multiplicity</span><span class="tsd-signature-symbol">:</span> <a href="../enums/Multiplicity.html" class="tsd-signature-type tsd-kind-enum">Multiplicity</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ListField.ts:14</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Field.html">Field</a>.<a href="Field.html#namLine truncated
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");