Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DigitalFlow committed Feb 4, 2021
1 parent c347198 commit 66662a1
Show file tree
Hide file tree
Showing 27 changed files with 922 additions and 121 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.json

Large diffs are not rendered by default.

28 changes: 17 additions & 11 deletions docs/classes/attribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Attribute.ts#L9">src/xrm/Attribute.ts:9</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Attribute.ts#L23">src/xrm/Attribute.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -140,7 +140,7 @@ <h3>get<wbr>Required<wbr>Level</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Attribute.ts#L22">src/xrm/Attribute.ts:22</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Attribute.ts#L36">src/xrm/Attribute.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -174,7 +174,7 @@ <h3>get<wbr>Value</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Attribute.ts#L37">src/xrm/Attribute.ts:37</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Attribute.ts#L51">src/xrm/Attribute.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -202,13 +202,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<a name="setvalue" class="tsd-anchor"></a>
<h3>set<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Value<span class="tsd-signature-symbol">(</span>attributeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, settleTime<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">set<wbr>Value<span class="tsd-signature-symbol">(</span>attributeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, settings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/setvaluesettings.html" class="tsd-signature-type">SetValueSettings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Attribute.ts#L67">src/xrm/Attribute.ts:67</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Attribute.ts#L81">src/xrm/Attribute.ts:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -235,10 +235,10 @@ <h5>value: <span class="tsd-signature-type">any</span></h5>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> settleTime: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 500</span></h5>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> settings: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/setvaluesettings.html" class="tsd-signature-type">SetValueSettings</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Time to wait (ms) after setting value for letting onChange events occur.</p>
<p>Settings defining time to wait (ms) after setting value for letting onChange events occur and whether to also write into hidden and readonly fields.</p>
</div>
</div>
</li>
Expand All @@ -252,13 +252,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<a name="setvalues" class="tsd-anchor"></a>
<h3>set<wbr>Values</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Values<span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, settleTime<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">set<wbr>Values<span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, settings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/setvaluesettings.html" class="tsd-signature-type">SetValueSettings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Attribute.ts#L99">src/xrm/Attribute.ts:99</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Attribute.ts#L123">src/xrm/Attribute.ts:123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -287,10 +287,10 @@ <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-t
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> settleTime: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2000</span></h5>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> settings: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/setvaluesettings.html" class="tsd-signature-type">SetValueSettings</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Time to wait after setting the values for letting onChange events occur</p>
<p>Settings defining time to wait (ms) after setting value for letting onChange events occur and whether to also write into hidden and readonly fields.</p>
</div>
</div>
</li>
Expand Down Expand Up @@ -423,12 +423,18 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-interface">
<a href="../interfaces/formidentifier.html" class="tsd-kind-icon">Form<wbr>Identifier</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/navigationsettings.html" class="tsd-kind-icon">Navigation<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/openproperties.html" class="tsd-kind-icon">Open<wbr>Properties</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/sectionstate.html" class="tsd-kind-icon">Section<wbr>State</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/setvaluesettings.html" class="tsd-kind-icon">Set<wbr>Value<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/tabstate.html" class="tsd-kind-icon">Tab<wbr>State</a>
</li>
Expand Down
62 changes: 57 additions & 5 deletions docs/classes/button.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ <h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="button.html#click" class="tsd-kind-icon">click</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="button.html#expandmorecommands" class="tsd-kind-icon">expand<wbr>More<wbr>Commands</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="button.html#isvisible" class="tsd-kind-icon">is<wbr>Visible</a></li>
</ul>
</section>
</div>
Expand All @@ -112,7 +113,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Button.ts#L35">src/xrm/Button.ts:35</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Button.ts#L35">src/xrm/Button.ts:35</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -138,7 +139,7 @@ <h3>click</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Button.ts#L72">src/xrm/Button.ts:72</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Button.ts#L79">src/xrm/Button.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -174,25 +175,67 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<a name="expandmorecommands" class="tsd-anchor"></a>
<h3>expand<wbr>More<wbr>Commands</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">expand<wbr>More<wbr>Commands<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">expand<wbr>More<wbr>Commands<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Button.ts#L47">src/xrm/Button.ts:47</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Button.ts#L47">src/xrm/Button.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Expands the more commands ribbon menu</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Promise which resolves once more commands was clicked</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="isvisible" class="tsd-anchor"></a>
<h3>is<wbr>Visible</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">is<wbr>Visible<span class="tsd-signature-symbol">(</span>buttonIdentifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/buttonidentifier.html" class="tsd-signature-type">ButtonIdentifier</a>, openMoreCommands<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Button.ts#L102">src/xrm/Button.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks if a button is visible</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>buttonIdentifier: <a href="../interfaces/buttonidentifier.html" class="tsd-signature-type">ButtonIdentifier</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Identifier for finding button, either by label or by data-id</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> openMoreCommands: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Whether more commands has to be clicked for finding the button. Will be used automatically if button is not found on first try</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Promise which resolves with a boolean value indicating if the button was visible</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand Down Expand Up @@ -267,6 +310,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="button.html#expandmorecommands" class="tsd-kind-icon">expand<wbr>More<wbr>Commands</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="button.html#isvisible" class="tsd-kind-icon">is<wbr>Visible</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -310,12 +356,18 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-interface">
<a href="../interfaces/formidentifier.html" class="tsd-kind-icon">Form<wbr>Identifier</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/navigationsettings.html" class="tsd-kind-icon">Navigation<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/openproperties.html" class="tsd-kind-icon">Open<wbr>Properties</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/sectionstate.html" class="tsd-kind-icon">Section<wbr>State</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/setvaluesettings.html" class="tsd-kind-icon">Set<wbr>Value<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/tabstate.html" class="tsd-kind-icon">Tab<wbr>State</a>
</li>
Expand Down
12 changes: 9 additions & 3 deletions docs/classes/control.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Control.ts#L24">src/xrm/Control.ts:24</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Control.ts#L24">src/xrm/Control.ts:24</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -138,7 +138,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Control.ts#L37">src/xrm/Control.ts:37</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Control.ts#L37">src/xrm/Control.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -172,7 +172,7 @@ <h3>get<wbr>Options</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/8ce0d3c/src/xrm/Control.ts#L57">src/xrm/Control.ts:57</a></li>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Control.ts#L57">src/xrm/Control.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -313,12 +313,18 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-interface">
<a href="../interfaces/formidentifier.html" class="tsd-kind-icon">Form<wbr>Identifier</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/navigationsettings.html" class="tsd-kind-icon">Navigation<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/openproperties.html" class="tsd-kind-icon">Open<wbr>Properties</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/sectionstate.html" class="tsd-kind-icon">Section<wbr>State</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/setvaluesettings.html" class="tsd-kind-icon">Set<wbr>Value<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/tabstate.html" class="tsd-kind-icon">Tab<wbr>State</a>
</li>
Expand Down
Loading

0 comments on commit 66662a1

Please sign in to comment.