@adcops/autocore-react 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/core/EventEmitterContext.d.ts +42 -2
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/components_Indicator.Indicator.html +6 -6
- package/docs/classes/components_IndicatorButton.IndicatorButton.html +12 -12
- package/docs/classes/components_ValueDisplay.ValueDisplay.html +23 -6
- package/docs/classes/core_ValueSimulator.ValueSimulator.html +12 -2
- package/docs/classes/hub_HubBase.HubBase.html +44 -15
- package/docs/classes/hub_HubSimulate.HubSimulate.html +16 -20
- package/docs/classes/hub_HubSocketIo.HubSocketIo.html +33 -21
- package/docs/classes/hub_HubTauri.HubTauri.html +19 -16
- package/docs/enums/components_DPad.VcJoyPadAction.html +4 -4
- package/docs/enums/components_DPad.VcJoyPadButtonId.html +2 -2
- package/docs/enums/components_IndicatorButton.ActionMode.html +2 -2
- package/docs/enums/components_IndicatorColor.IndicatorColor.html +12 -2
- package/docs/functions/components_DPad.VcDPad.html +1 -1
- package/docs/functions/core_EventEmitterContext.EventEmitterProvider.html +1 -1
- package/docs/functions/core_UniqueId.UniqueId.html +6 -1
- package/docs/functions/core_hoc.hocAddSubscription.html +1 -1
- package/docs/functions/hub.createHub.html +1 -1
- package/docs/index.html +11 -2
- package/docs/interfaces/components_IndicatorButton.IndicatorButtonProps.html +15 -13
- package/docs/interfaces/components_IndicatorButton.IndicatorButtonState.html +5 -5
- package/docs/interfaces/core_EventEmitterContext.Action.html +6 -3
- package/docs/interfaces/core_EventEmitterContext.EventEmitterContextType.html +19 -7
- package/docs/interfaces/core_EventEmitterContext.State.html +4 -4
- package/docs/interfaces/core_EventEmitterContext.Subscription.html +3 -3
- package/docs/interfaces/core_PositionContext.IPositionContext.html +17 -0
- package/docs/modules/{core_InputPatterns.html → core_MaskPatterns.html} +2 -1
- package/docs/modules/core_PositionContext.html +4 -0
- package/docs/types/core_EventEmitterContext.EmitterDispatchFunction.html +3 -1
- package/docs/types/core_EventEmitterContext.EmitterSubscribeFunction.html +3 -1
- package/docs/types/core_EventEmitterContext.EmitterUnsubscribeFunction.html +3 -1
- package/docs/types/core_NumerableTypes.NumerableFormatOptions.html +4 -1
- package/docs/types/core_hoc.HocAddSubscriptionProps.html +1 -1
- package/docs/variables/core_EventEmitterContext.EventEmitterContext.html +57 -4
- package/docs/variables/core_MaskPatterns.PrimeReactMaskPatterns.html +14 -0
- package/docs/variables/core_MaskPatterns.RegExMaskPatterns.html +14 -0
- package/docs/variables/core_PositionContext.DimensionsContext.html +6 -0
- package/package.json +2 -2
- package/docs/interfaces/core_DimensionsContext.IDimensionsContext.html +0 -4
- package/docs/modules/core_DimensionsContext.html +0 -4
- package/docs/variables/core_DimensionsContext.DimensionsContext.html +0 -1
- package/docs/variables/core_InputPatterns.InputPatterns.html +0 -2
|
@@ -9,10 +9,13 @@ listeners in the web app.</p>
|
|
|
9
9
|
<p>The hub should also be used for invoking events in the Tauri backend.
|
|
10
10
|
This example will call the function "update_count" in the rust backend, passing
|
|
11
11
|
the expected argument "count".</p>
|
|
12
|
-
<pre><code><span class="hl-3">const</span><span class="hl-1"> {</span><span class="hl-7">
|
|
12
|
+
<pre><code><span class="hl-3">const</span><span class="hl-1"> {</span><span class="hl-7">invoke</span><span class="hl-1">} = </span><span class="hl-8">useContext</span><span class="hl-1">(</span><span class="hl-0">EventEmitterContext</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-8">incrementCount</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">count</span><span class="hl-1"> += </span><span class="hl-5">1</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">invoke</span><span class="hl-1">(</span><span class="hl-10">'update_count'</span><span class="hl-1">, {</span><span class="hl-10">"count"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">count</span><span class="hl-1">}); </span><br/><span class="hl-1">};</span>
|
|
13
13
|
</code><button>Copy</button></pre>
|
|
14
|
-
<p>Of course, like any class derived from HubBase, the
|
|
15
|
-
|
|
14
|
+
<p>Of course, like any class derived from HubBase, the hub can be used to publish and subscribe to
|
|
15
|
+
topics in the front-end, without need of interacting with the Tauri backed.</p>
|
|
16
|
+
<pre><code><span class="hl-3">const</span><span class="hl-1"> {</span><span class="hl-7">dispatch</span><span class="hl-1">, </span><span class="hl-7">subscribe</span><span class="hl-1">, </span><span class="hl-7">unsubscribe</span><span class="hl-1">} = </span><span class="hl-8">useContext</span><span class="hl-1">(</span><span class="hl-0">EventEmitterContext</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> [</span><span class="hl-7">controlPower</span><span class="hl-1">, </span><span class="hl-7">setControlPower</span><span class="hl-1">] = </span><span class="hl-8">useState</span><span class="hl-1">(</span><span class="hl-3">false</span><span class="hl-1">);</span><br/><span class="hl-8">useEffect</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-7">unsubscribeControlPower</span><span class="hl-1"> = </span><span class="hl-8">subscribe</span><span class="hl-1">(</span><span class="hl-10">'value-simulator-bBit1'</span><span class="hl-1">, (</span><span class="hl-0">value</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">setControlPower</span><span class="hl-1">(</span><span class="hl-0">value</span><span class="hl-1">);</span><br/><span class="hl-1"> }); </span><br/><br/><br/><span class="hl-1"> </span><span class="hl-9">return</span><span class="hl-1"> () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">unsubscribe</span><span class="hl-1">(</span><span class="hl-0">unsubscribeControlPower</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}, [] );</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-8">onPbPressed</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">let</span><span class="hl-1"> </span><span class="hl-0">count</span><span class="hl-1"> = </span><span class="hl-5">1</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">dispatch</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">topic:</span><span class="hl-1"> </span><span class="hl-10">"my-awesome-topic"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">payload:</span><span class="hl-1"> </span><span class="hl-0">count</span><br/><span class="hl-1"> });</span><br/><span class="hl-1">}</span><br/>
|
|
17
|
+
</code><button>Copy</button></pre>
|
|
18
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#hub/HubTauri.HubTauri">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="hub_HubBase.HubBase.html" class="tsd-signature-type tsd-kind-class">HubBase</a><ul class="tsd-hierarchy"><li><span class="target">HubTauri</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/hub/HubTauri.ts:88</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="hub_HubTauri.HubTauri.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>
|
|
16
19
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="hub_HubTauri.HubTauri.html#backendFNameToLocalFNameMap" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>backendFName<wbr/>To<wbr/>LocalFName<wbr/>Map</span></a>
|
|
17
20
|
<a href="hub_HubTauri.HubTauri.html#backendTopicToLocalMap" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>backend<wbr/>Topic<wbr/>To<wbr/>Local<wbr/>Map</span></a>
|
|
18
21
|
<a href="hub_HubTauri.HubTauri.html#context" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a>
|
|
@@ -31,50 +34,50 @@ the expected argument "count".</p>
|
|
|
31
34
|
<a href="hub_HubTauri.HubTauri.html#unmapFName" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmapFName</span></a>
|
|
32
35
|
<a href="hub_HubTauri.HubTauri.html#unmapTopic" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmap<wbr/>Topic</span></a>
|
|
33
36
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_HubTauri" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Hub<wbr/>Tauri</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="hub_HubTauri.HubTauri.html" class="tsd-signature-type tsd-kind-class">HubTauri</a><a href="#constructor.new_HubTauri" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructor</p>
|
|
34
|
-
</div><h4 class="tsd-returns-title">Returns <a href="hub_HubTauri.HubTauri.html" class="tsd-signature-type tsd-kind-class">HubTauri</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#constructor">constructor</a></p><ul><li>Defined in src/hub/HubTauri.ts:
|
|
37
|
+
</div><h4 class="tsd-returns-title">Returns <a href="hub_HubTauri.HubTauri.html" class="tsd-signature-type tsd-kind-class">HubTauri</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#constructor">constructor</a></p><ul><li>Defined in src/hub/HubTauri.ts:93</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-protected tsd-is-inherited"><a id="backendFNameToLocalFNameMap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>backendFName<wbr/>To<wbr/>LocalFName<wbr/>Map</span><a href="#backendFNameToLocalFNameMap" 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">backendFName<wbr/>To<wbr/>LocalFName<wbr/>Map</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#backendFNameToLocalFNameMap">backendFNameToLocalFNameMap</a></p><ul><li>Defined in src/hub/HubBase.ts:94</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="backendTopicToLocalMap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>backend<wbr/>Topic<wbr/>To<wbr/>Local<wbr/>Map</span><a href="#backendTopicToLocalMap" 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">backend<wbr/>Topic<wbr/>To<wbr/>Local<wbr/>Map</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#backendTopicToLocalMap">backendTopicToLocalMap</a></p><ul><li>Defined in src/hub/HubBase.ts:92</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="context" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>context</span><a href="#context" 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">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/core_EventEmitterContext.EventEmitterContextType.html" class="tsd-signature-type tsd-kind-interface">EventEmitterContextType</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#context">context</a></p><ul><li>Defined in src/hub/HubBase.ts:96</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="localFNameToBackendFNameMap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>localFName<wbr/>To<wbr/>BackendFName<wbr/>Map</span><a href="#localFNameToBackendFNameMap" 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">localFName<wbr/>To<wbr/>BackendFName<wbr/>Map</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#localFNameToBackendFNameMap">localFNameToBackendFNameMap</a></p><ul><li>Defined in src/hub/HubBase.ts:93</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="localTopicToBackendTopicMap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>local<wbr/>Topic<wbr/>To<wbr/>Backend<wbr/>Topic<wbr/>Map</span><a href="#localTopicToBackendTopicMap" 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">local<wbr/>Topic<wbr/>To<wbr/>Backend<wbr/>Topic<wbr/>Map</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#localTopicToBackendTopicMap">localTopicToBackendTopicMap</a></p><ul><li>Defined in src/hub/HubBase.ts:91</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="invoke" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>invoke</span><a href="#invoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="invoke.invoke-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">invoke</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fname</span>, <span class="tsd-kind-parameter">payload</span><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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><a href="#invoke.invoke-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invoke a method in the rust backend.</p>
|
|
35
38
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fname</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>method name</p>
|
|
36
39
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-type">object</span></span><div class="tsd-comment tsd-typography"><p>Optional data payload</p>
|
|
37
40
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4><p>The return value of the backend method.</p>
|
|
38
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#invoke">invoke</a></p><ul><li>Defined in src/hub/HubTauri.ts:
|
|
41
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#invoke">invoke</a></p><ul><li>Defined in src/hub/HubTauri.ts:131</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="invokeTopic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>invoke<wbr/>Topic</span><a href="#invokeTopic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="invokeTopic.invokeTopic-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">invoke<wbr/>Topic</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fname</span>, <span class="tsd-kind-parameter">topic</span>, <span class="tsd-kind-parameter">value</span><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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><a href="#invokeTopic.invokeTopic-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Convenience function to invoke a command with an optional topic and optional value.
|
|
39
42
|
This will invoke the specified command in the backend. It does not broadcast the
|
|
40
43
|
value within the local frontend.</p>
|
|
41
44
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fname</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>string Function name</p>
|
|
42
45
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">topic</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>string Topic</p>
|
|
43
46
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>any data payload</p>
|
|
44
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#invokeTopic">invokeTopic</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
47
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#invokeTopic">invokeTopic</a></p><ul><li>Defined in src/hub/HubBase.ts:136</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="mapFName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mapFName</span><a href="#mapFName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="mapFName.mapFName-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mapFName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">localFName</span>, <span class="tsd-kind-parameter">backendFName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mapFName.mapFName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Map a local function name, as would be sent to the invoke method, to a
|
|
45
48
|
function name in the backend.</p>
|
|
46
49
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">localFName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>string</p>
|
|
47
50
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">backendFName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>string</p>
|
|
48
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#mapFName">mapFName</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
51
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#mapFName">mapFName</a></p><ul><li>Defined in src/hub/HubBase.ts:190</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="mapTopic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>map<wbr/>Topic</span><a href="#mapTopic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="mapTopic.mapTopic-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">map<wbr/>Topic</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">localTopic</span>, <span class="tsd-kind-parameter">backendTopic</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mapTopic.mapTopic-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Map a local topic to a topic in the backend.</p>
|
|
49
52
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">localTopic</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>string</p>
|
|
50
53
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">backendTopic</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>string</p>
|
|
51
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#mapTopic">mapTopic</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
54
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#mapTopic">mapTopic</a></p><ul><li>Defined in src/hub/HubBase.ts:163</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="publish" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>publish</span><a href="#publish" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="publish.publish-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">publish</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">topic</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#publish.publish-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Pubish a topic throughout the web app using the
|
|
52
55
|
Global EventEmitterContext. This will broadcast within the local frontend.
|
|
53
56
|
This does NOT get relayed to the backend.</p>
|
|
54
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">topic</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#publish">publish</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
57
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">topic</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#publish">publish</a></p><ul><li>Defined in src/hub/HubBase.ts:149</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Context</span><a href="#setContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="setContext.setContext-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Context</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setContext.setContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the EventEmitterContext for this instance of the Hub. The EventEmitterContext
|
|
55
58
|
should handle this as part of the initialization sequence. Because React can
|
|
56
59
|
sometimes make (and destroy) multiple copies of the EventEmitterContext, it's important
|
|
57
60
|
that the context be stored in the instance this way so that the HubBase can properly target
|
|
58
61
|
right context.</p>
|
|
59
62
|
<p>If this context is not sent, no events will be emitted from the backend to the front end,
|
|
60
63
|
and global events in the interface may not work.</p>
|
|
61
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/core_EventEmitterContext.EventEmitterContextType.html" class="tsd-signature-type tsd-kind-interface">EventEmitterContextType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#setContext">setContext</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
64
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/core_EventEmitterContext.EventEmitterContextType.html" class="tsd-signature-type tsd-kind-interface">EventEmitterContextType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#setContext">setContext</a></p><ul><li>Defined in src/hub/HubBase.ts:117</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toBackendFName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>BackendFName</span><a href="#toBackendFName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toBackendFName.toBackendFName-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>BackendFName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">localFName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toBackendFName.toBackendFName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Convert a local function name to a backend function name. If a mapping isn't
|
|
62
65
|
registered, the local FName is returned.</p>
|
|
63
66
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">localFName</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>string</p>
|
|
64
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#toBackendFName">toBackendFName</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
67
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#toBackendFName">toBackendFName</a></p><ul><li>Defined in src/hub/HubBase.ts:236</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toBackendTopic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Backend<wbr/>Topic</span><a href="#toBackendTopic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toBackendTopic.toBackendTopic-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Backend<wbr/>Topic</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">localTopic</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toBackendTopic.toBackendTopic-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Convert a local topic to a backend topic. If a mapping isn't
|
|
65
68
|
registered, the local topic is returned.</p>
|
|
66
69
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">localTopic</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>local topic name</p>
|
|
67
70
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>string</p>
|
|
68
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#toBackendTopic">toBackendTopic</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
71
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#toBackendTopic">toBackendTopic</a></p><ul><li>Defined in src/hub/HubBase.ts:217</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toLocalFName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>LocalFName</span><a href="#toLocalFName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toLocalFName.toLocalFName-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>LocalFName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">backendTopic</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toLocalFName.toLocalFName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Convert a backend function name to a local function name. If a mapping isn't
|
|
69
72
|
registered, the backend function name is returned.</p>
|
|
70
73
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">backendTopic</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>backend function name</p>
|
|
71
74
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>string</p>
|
|
72
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#toLocalFName">toLocalFName</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
75
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#toLocalFName">toLocalFName</a></p><ul><li>Defined in src/hub/HubBase.ts:276</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="toLocalTopic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Local<wbr/>Topic</span><a href="#toLocalTopic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="toLocalTopic.toLocalTopic-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Local<wbr/>Topic</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">backendTopic</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toLocalTopic.toLocalTopic-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Convert a backend topic to a local topic. If a mapping isn't
|
|
73
76
|
registered, the backend topic is returned.</p>
|
|
74
77
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">backendTopic</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>backend topic name</p>
|
|
75
78
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>string</p>
|
|
76
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#toLocalTopic">toLocalTopic</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
79
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#toLocalTopic">toLocalTopic</a></p><ul><li>Defined in src/hub/HubBase.ts:256</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unmapFName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unmapFName</span><a href="#unmapFName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="unmapFName.unmapFName-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unmapFName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">localFName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unmapFName.unmapFName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unmap a local function name.</p>
|
|
77
80
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">localFName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>string</p>
|
|
78
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#unmapFName">unmapFName</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
81
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#unmapFName">unmapFName</a></p><ul><li>Defined in src/hub/HubBase.ts:199</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unmapTopic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unmap<wbr/>Topic</span><a href="#unmapTopic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="unmapTopic.unmapTopic-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unmap<wbr/>Topic</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">localTopic</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unmapTopic.unmapTopic-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unmap a local topic.</p>
|
|
79
82
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">localTopic</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>string</p>
|
|
80
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#unmapTopic">unmapTopic</a></p><ul><li>Defined in src/hub/HubBase.ts:
|
|
83
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="hub_HubBase.HubBase.html">HubBase</a>.<a href="hub_HubBase.HubBase.html#unmapTopic">unmapTopic</a></p><ul><li>Defined in src/hub/HubBase.ts:172</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#backendFNameToLocalFNameMap" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>backendFName<wbr/>To<wbr/>LocalFName<wbr/>Map</span></a><a href="#backendTopicToLocalMap" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>backend<wbr/>Topic<wbr/>To<wbr/>Local<wbr/>Map</span></a><a href="#context" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a><a href="#localFNameToBackendFNameMap" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>localFName<wbr/>To<wbr/>BackendFName<wbr/>Map</span></a><a href="#localTopicToBackendTopicMap" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Topic<wbr/>To<wbr/>Backend<wbr/>Topic<wbr/>Map</span></a><a href="#invoke" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>invoke</span></a><a href="#invokeTopic" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>invoke<wbr/>Topic</span></a><a href="#mapFName" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mapFName</span></a><a href="#mapTopic" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>map<wbr/>Topic</span></a><a href="#publish" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>publish</span></a><a href="#setContext" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Context</span></a><a href="#toBackendFName" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>BackendFName</span></a><a href="#toBackendTopic" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Backend<wbr/>Topic</span></a><a href="#toLocalFName" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>LocalFName</span></a><a href="#toLocalTopic" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Local<wbr/>Topic</span></a><a href="#unmapFName" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmapFName</span></a><a href="#unmapTopic" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmap<wbr/>Topic</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>autocore-react - v3.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VcJoyPadAction | autocore-react - v3.0.0</title><meta name="description" content="Documentation for autocore-react"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></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">autocore-react - v3.0.0</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="../index.html">autocore-react</a></li><li><a href="../modules/components_DPad.html">components/DPad</a></li><li><a href="components_DPad.VcJoyPadAction.html">VcJoyPadAction</a></li></ul><h1>Enumeration VcJoyPadAction</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Enumerates the source button or action when an event occurs.</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:17</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">Enumeration Members</h3><div class="tsd-index-list"><a href="components_DPad.VcJoyPadAction.html#Down" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Down</span></a>
|
|
3
3
|
<a href="components_DPad.VcJoyPadAction.html#Invalid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Invalid</span></a>
|
|
4
4
|
<a href="components_DPad.VcJoyPadAction.html#Left" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Left</span></a>
|
|
5
5
|
<a href="components_DPad.VcJoyPadAction.html#Right" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Right</span></a>
|
|
6
6
|
<a href="components_DPad.VcJoyPadAction.html#Stop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Stop</span></a>
|
|
7
7
|
<a href="components_DPad.VcJoyPadAction.html#Up" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Up</span></a>
|
|
8
|
-
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Down" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Down</span><a href="#Down" 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-enum-member">Down</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:
|
|
9
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:
|
|
10
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:
|
|
8
|
+
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Down" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Down</span><a href="#Down" 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-enum-member">Down</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:22</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Invalid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Invalid</span><a href="#Invalid" 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-enum-member">Invalid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><div class="tsd-comment tsd-typography"><p>Invalid - Ignore this button</p>
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:19</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Left" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Left</span><a href="#Left" 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-enum-member">Left</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">4</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:23</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Right" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Right</span><a href="#Right" 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-enum-member">Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Stop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Stop</span><a href="#Stop" 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-enum-member">Stop</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">16</span></div><div class="tsd-comment tsd-typography"><p>Stop, clear or reset</p>
|
|
10
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:25</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Up" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Up</span><a href="#Up" 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-enum-member">Up</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:20</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Down" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Down</span></a><a href="#Invalid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Invalid</span></a><a href="#Left" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Left</span></a><a href="#Right" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Right</span></a><a href="#Stop" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Stop</span></a><a href="#Up" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Up</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>autocore-react - v3.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VcJoyPadButtonId | autocore-react - v3.0.0</title><meta name="description" content="Documentation for autocore-react"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></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">autocore-react - v3.0.0</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="../index.html">autocore-react</a></li><li><a href="../modules/components_DPad.html">components/DPad</a></li><li><a href="components_DPad.VcJoyPadButtonId.html">VcJoyPadButtonId</a></li></ul><h1>Enumeration VcJoyPadButtonId</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Enumerates the id's of buttons used in the joypad for standardization.</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:31</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">Enumeration Members</h3><div class="tsd-index-list"><a href="components_DPad.VcJoyPadButtonId.html#Down" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Down</span></a>
|
|
3
3
|
<a href="components_DPad.VcJoyPadButtonId.html#Left" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Left</span></a>
|
|
4
4
|
<a href="components_DPad.VcJoyPadButtonId.html#Right" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Right</span></a>
|
|
5
5
|
<a href="components_DPad.VcJoyPadButtonId.html#Stop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Stop</span></a>
|
|
6
6
|
<a href="components_DPad.VcJoyPadButtonId.html#Up" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Up</span></a>
|
|
7
|
-
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Down" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Down</span><a href="#Down" 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-enum-member">Down</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"down"</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:
|
|
7
|
+
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Down" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Down</span><a href="#Down" 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-enum-member">Down</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"down"</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:35</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Left" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Left</span><a href="#Left" 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-enum-member">Left</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"left"</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:36</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Right" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Right</span><a href="#Right" 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-enum-member">Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"right"</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:34</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Stop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Stop</span><a href="#Stop" 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-enum-member">Stop</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"stop"</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:32</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Up" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Up</span><a href="#Up" 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-enum-member">Up</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"up"</span></div><aside class="tsd-sources"><ul><li>Defined in src/components/DPad.tsx:33</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Down" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Down</span></a><a href="#Left" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Left</span></a><a href="#Right" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Right</span></a><a href="#Stop" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Stop</span></a><a href="#Up" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Up</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>autocore-react - v3.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>
|