@adcops/autocore-react 3.0.14 → 3.0.16
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/components/FileList.d.ts +38 -0
- package/dist/components/FileList.js +1 -0
- package/dist/hub/HubWebSocket.d.ts +10 -0
- package/dist/hub/HubWebSocket.js +1 -1
- package/dist/hub/index.js +1 -1
- package/docs/classes/components_BlocklyEditor.BlocklyEditor.html +2 -2
- package/docs/classes/components_CodeEditor.CodeEditor.html +2 -2
- package/docs/classes/components_JogPanel.JogPanel.html +2 -2
- package/docs/classes/components_Lamp.Lamp.html +2 -2
- package/docs/classes/components_TextInput.TextInput.html +115 -0
- package/docs/classes/components_ValueIndicator.ValueIndicator.html +119 -0
- package/docs/classes/components_ValueInput.ValueInput.html +12 -14
- package/docs/classes/hub_HubWebSocket.HubWebSocket.html +106 -0
- package/docs/enums/components_JogPanel.JogDistanceAction.html +2 -2
- package/docs/enums/components_JogPanel.JogPanelAction.html +2 -2
- package/docs/enums/components_JogPanel.JogSpeedAction.html +2 -2
- package/docs/enums/core_ActionMode.ActionMode.html +2 -2
- package/docs/enums/core_IndicatorColor.IndicatorColor.html +2 -2
- package/docs/functions/assets_BlocklyLogo.default.html +1 -1
- package/docs/functions/assets_Distance.default.html +1 -1
- package/docs/functions/assets_JogLong.default.html +1 -1
- package/docs/functions/assets_JogMedium.default.html +1 -1
- package/docs/functions/assets_JogShort.default.html +1 -1
- package/docs/functions/assets_PythonLogo.default.html +1 -1
- package/docs/functions/assets_Rotation3D.default.html +1 -1
- package/docs/functions/assets_RotationCcw.default.html +1 -1
- package/docs/functions/assets_RotationCcwA.default.html +1 -1
- package/docs/functions/assets_RotationCcwB.default.html +1 -1
- package/docs/functions/assets_RotationCcwC.default.html +1 -1
- package/docs/functions/assets_RotationCw.default.html +1 -1
- package/docs/functions/assets_RotationCwA.default.html +1 -1
- package/docs/functions/assets_RotationCwB.default.html +1 -1
- package/docs/functions/assets_RotationCwC.default.html +1 -1
- package/docs/functions/assets_Run.default.html +1 -1
- package/docs/functions/assets_Speed.default.html +1 -1
- package/docs/functions/assets_SpeedFast.default.html +1 -1
- package/docs/functions/assets_SpeedMedium.default.html +1 -1
- package/docs/functions/assets_SpeedNone.default.html +1 -1
- package/docs/functions/assets_SpeedSlow.default.html +1 -1
- package/docs/functions/assets_Walk.default.html +1 -1
- package/docs/functions/components_BlocklyEditor.createCustomToolbox.html +2 -2
- package/docs/functions/components_FileList.FileList.html +21 -0
- package/docs/functions/components_FitText.FitText.html +8 -0
- package/docs/functions/components_ToggleGroup.ToggleGroup.html +5 -0
- package/docs/interfaces/components_JogPanel.JogPanelButtonDefinition.html +2 -2
- package/docs/interfaces/components_ToggleGroup.ToggleGroupProps.html +12 -30
- package/docs/interfaces/core_IndicatorButtonState.IndicatorButtonState.html +2 -2
- package/docs/interfaces/hub_CommandMessage.CommandMessage.html +6 -0
- package/docs/interfaces/hub_CommandMessage.CommandMessageResult.html +4 -0
- package/docs/modules/assets.html +2 -2
- package/docs/modules/assets_BlocklyLogo.html +2 -2
- package/docs/modules/assets_Distance.html +2 -2
- package/docs/modules/assets_JogLong.html +2 -2
- package/docs/modules/assets_JogMedium.html +2 -2
- package/docs/modules/assets_JogShort.html +2 -2
- package/docs/modules/assets_PythonLogo.html +2 -2
- package/docs/modules/assets_Rotation3D.html +2 -2
- package/docs/modules/assets_RotationCcw.html +2 -2
- package/docs/modules/assets_RotationCcwA.html +2 -2
- package/docs/modules/assets_RotationCcwB.html +2 -2
- package/docs/modules/assets_RotationCcwC.html +2 -2
- package/docs/modules/assets_RotationCw.html +2 -2
- package/docs/modules/assets_RotationCwA.html +2 -2
- package/docs/modules/assets_RotationCwB.html +2 -2
- package/docs/modules/assets_RotationCwC.html +2 -2
- package/docs/modules/assets_Run.html +2 -2
- package/docs/modules/assets_Speed.html +2 -2
- package/docs/modules/assets_SpeedFast.html +2 -2
- package/docs/modules/assets_SpeedMedium.html +2 -2
- package/docs/modules/assets_SpeedNone.html +2 -2
- package/docs/modules/assets_SpeedSlow.html +2 -2
- package/docs/modules/assets_Walk.html +2 -2
- package/docs/modules/components_BlocklyEditor.html +2 -2
- package/docs/modules/components_CodeEditor.html +2 -2
- package/docs/modules/{hub_HubSimulate.html → components_FileList.html} +3 -3
- package/docs/modules/components_FitText.html +3 -0
- package/docs/modules/components_JogPanel.html +2 -2
- package/docs/modules/components_Lamp.html +2 -2
- package/docs/modules/{hub_HubTauri.html → components_TextInput.html} +2 -2
- package/docs/modules/components_ToggleGroup.html +4 -3
- package/docs/modules/components_ValueIndicator.html +4 -0
- package/docs/modules/components_ValueInput.html +2 -2
- package/docs/modules/core_ActionMode.html +2 -2
- package/docs/modules/core_IndicatorButtonState.html +2 -2
- package/docs/modules/core_IndicatorColor.html +2 -2
- package/docs/modules/{core_NumerableTypes.html → hub_CommandMessage.html} +3 -2
- package/docs/modules/{core_MaskPatterns.html → hub_HubWebSocket.html} +2 -3
- package/docs/types/components_IndicatorButton.IndicatorButtonOptionsType.html +1 -1
- package/docs/variables/components_BlocklyEditor.StandardToolbox.html +1 -1
- package/docs/variables/components_JogPanel.DefaultLinearJogButtons.html +2 -2
- package/docs/variables/components_JogPanel.DefaultRotationJogButtons.html +2 -2
- package/package.json +1 -1
- package/src/components/FileList.tsx +245 -0
- package/src/hub/HubWebSocket.ts +147 -7
- package/src/hub/index.ts +12 -12
- package/docs/.nojekyll +0 -1
- package/docs/assets/highlight.css +0 -113
- package/docs/assets/icons.js +0 -15
- package/docs/assets/icons.svg +0 -1
- package/docs/assets/main.js +0 -59
- package/docs/assets/navigation.js +0 -1
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1414
- package/docs/classes/components_Indicator.Indicator.html +0 -105
- package/docs/classes/components_IndicatorButton.IndicatorButton.html +0 -119
- package/docs/classes/components_OskDialog.OskDialog.html +0 -117
- package/docs/classes/components_ToggleGroup.ToggleGroup.html +0 -118
- package/docs/classes/components_ValueDisplay.ValueDisplay.html +0 -121
- package/docs/classes/core_ValueSimulator.ValueSimulator.html +0 -51
- package/docs/classes/hub_HubBase.HubBase.html +0 -96
- package/docs/classes/hub_HubSimulate.HubSimulate.html +0 -68
- package/docs/classes/hub_HubSocketIo.HubSocketIo.html +0 -92
- package/docs/classes/hub_HubTauri.HubTauri.html +0 -83
- package/docs/functions/components_Osk.Osk.html +0 -5
- package/docs/functions/core_EventEmitterContext.EventEmitterProvider.html +0 -8
- package/docs/functions/core_UniqueId.UniqueId.html +0 -9
- package/docs/functions/core_hoc.hocAddSubscription.html +0 -6
- package/docs/functions/hub.createHub.html +0 -3
- package/docs/hierarchy.html +0 -1
- package/docs/index.html +0 -94
- package/docs/interfaces/components_IndicatorButton.IndicatorButtonProps.html +0 -665
- package/docs/interfaces/core_EventEmitterContext.Action.html +0 -8
- package/docs/interfaces/core_EventEmitterContext.EventEmitterContextType.html +0 -30
- package/docs/interfaces/core_EventEmitterContext.State.html +0 -8
- package/docs/interfaces/core_EventEmitterContext.Subscription.html +0 -6
- package/docs/interfaces/core_PositionContext.IPositionContext.html +0 -17
- package/docs/modules/components_Indicator.html +0 -4
- package/docs/modules/components_IndicatorButton.html +0 -7
- package/docs/modules/components_Osk.html +0 -3
- package/docs/modules/components_OskDialog.html +0 -3
- package/docs/modules/components_ValueDisplay.html +0 -3
- package/docs/modules/core_EventEmitterContext.html +0 -11
- package/docs/modules/core_PositionContext.html +0 -4
- package/docs/modules/core_UniqueId.html +0 -2
- package/docs/modules/core_ValueSimulator.html +0 -3
- package/docs/modules/core_hoc.html +0 -3
- package/docs/modules/hub.html +0 -6
- package/docs/modules/hub_HubBase.html +0 -3
- package/docs/modules/hub_HubSocketIo.html +0 -3
- package/docs/types/core_EventEmitterContext.EmitterDispatchFunction.html +0 -3
- package/docs/types/core_EventEmitterContext.EmitterSubscribeFunction.html +0 -3
- package/docs/types/core_EventEmitterContext.EmitterUnsubscribeFunction.html +0 -3
- package/docs/types/core_NumerableTypes.NumerableFormatOptions.html +0 -4
- package/docs/types/core_hoc.HocAddSubscriptionProps.html +0 -4
- package/docs/variables/core_EventEmitterContext.EventEmitterContext.html +0 -58
- package/docs/variables/core_MaskPatterns.PrimeReactMaskPatterns.html +0 -14
- package/docs/variables/core_MaskPatterns.RegExMaskPatterns.html +0 -15
- package/docs/variables/core_PositionContext.DimensionsContext.html +0 -6
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValueDisplay | autocore-react - v3.0.3</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.3</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_ValueDisplay.html">components/ValueDisplay</a></li><li><a href="components_ValueDisplay.ValueDisplay.html">ValueDisplay</a></li></ul><h1>Class ValueDisplay</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p><code>ValueDisplay</code> is a React component that subscribes to a value from an <code>EventEmitterContext</code> and renders it.
|
|
2
|
-
This component adjusts its display based on the provided properties, including positioning and styling adjustments
|
|
3
|
-
based on its context. It is designed to work within a system that provides dynamic updates to values via an event emitter.</p>
|
|
4
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Component</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Props</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">ValueDisplay</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/components/ValueDisplay.tsx:91</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="components_ValueDisplay.ValueDisplay.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>
|
|
5
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="components_ValueDisplay.ValueDisplay.html#context" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a>
|
|
6
|
-
<a href="components_ValueDisplay.ValueDisplay.html#props" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>props</span></a>
|
|
7
|
-
<a href="components_ValueDisplay.ValueDisplay.html#refs" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refs</span></a>
|
|
8
|
-
<a href="components_ValueDisplay.ValueDisplay.html#state" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a>
|
|
9
|
-
<a href="components_ValueDisplay.ValueDisplay.html#unsubscribeTopicId" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>Topic<wbr/>Id</span></a>
|
|
10
|
-
<a href="components_ValueDisplay.ValueDisplay.html#contextType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Type</span></a>
|
|
11
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="components_ValueDisplay.ValueDisplay.html#UNSAFE_componentWillMount" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>UNSAFE_<wbr/>component<wbr/>Will<wbr/>Mount?</span></a>
|
|
12
|
-
<a href="components_ValueDisplay.ValueDisplay.html#UNSAFE_componentWillReceiveProps" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>UNSAFE_<wbr/>component<wbr/>Will<wbr/>Receive<wbr/>Props?</span></a>
|
|
13
|
-
<a href="components_ValueDisplay.ValueDisplay.html#UNSAFE_componentWillUpdate" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>UNSAFE_<wbr/>component<wbr/>Will<wbr/>Update?</span></a>
|
|
14
|
-
<a href="components_ValueDisplay.ValueDisplay.html#componentDidCatch" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Catch?</span></a>
|
|
15
|
-
<a href="components_ValueDisplay.ValueDisplay.html#componentDidMount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a>
|
|
16
|
-
<a href="components_ValueDisplay.ValueDisplay.html#componentDidUpdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Update</span></a>
|
|
17
|
-
<a href="components_ValueDisplay.ValueDisplay.html#componentWillMount" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Mount?</span></a>
|
|
18
|
-
<a href="components_ValueDisplay.ValueDisplay.html#componentWillReceiveProps" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Receive<wbr/>Props?</span></a>
|
|
19
|
-
<a href="components_ValueDisplay.ValueDisplay.html#componentWillUnmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a>
|
|
20
|
-
<a href="components_ValueDisplay.ValueDisplay.html#componentWillUpdate" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Update?</span></a>
|
|
21
|
-
<a href="components_ValueDisplay.ValueDisplay.html#forceUpdate" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>force<wbr/>Update</span></a>
|
|
22
|
-
<a href="components_ValueDisplay.ValueDisplay.html#getSnapshotBeforeUpdate" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Snapshot<wbr/>Before<wbr/>Update?</span></a>
|
|
23
|
-
<a href="components_ValueDisplay.ValueDisplay.html#render" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render</span></a>
|
|
24
|
-
<a href="components_ValueDisplay.ValueDisplay.html#setState" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>State</span></a>
|
|
25
|
-
<a href="components_ValueDisplay.ValueDisplay.html#shouldComponentUpdate" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Component<wbr/>Update?</span></a>
|
|
26
|
-
</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_ValueDisplay" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Value<wbr/>Display</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="components_ValueDisplay.ValueDisplay.html" class="tsd-signature-type tsd-kind-class">ValueDisplay</a><a href="#constructor.new_ValueDisplay" 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>The constructor initializes the component state and binds the initial value.</p>
|
|
27
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">Props</span></span><div class="tsd-comment tsd-typography"><p>The properties passed to the component, including initial value and other display options.</p>
|
|
28
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="components_ValueDisplay.ValueDisplay.html" class="tsd-signature-type tsd-kind-class">ValueDisplay</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Component<Props, State>.constructor</p><ul><li>Defined in src/components/ValueDisplay.tsx:104</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="context" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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">unknown</span></div><div class="tsd-comment tsd-typography"><p>If using the new style context, re-declare this in your class to be the
|
|
29
|
-
<code>React.ContextType</code> of your <code>static contextType</code>.
|
|
30
|
-
Should be used with type annotation or static contextType.</p>
|
|
31
|
-
<pre><code class="language-ts"><span class="hl-0">static</span><span class="hl-1"> </span><span class="hl-0">contextType</span><span class="hl-1"> = </span><span class="hl-0">MyContext</span><br/><span class="hl-5">// For TS pre-3.7:</span><br/><span class="hl-0">context</span><span class="hl-1">!: </span><span class="hl-0">React</span><span class="hl-1">.</span><span class="hl-0">ContextType</span><span class="hl-1"><</span><span class="hl-6">typeof</span><span class="hl-1"> </span><span class="hl-0">MyContext</span><span class="hl-1">></span><br/><span class="hl-5">// For TS 3.7 and above:</span><br/><span class="hl-6">declare</span><span class="hl-1"> </span><span class="hl-7">context</span><span class="hl-1">: </span><span class="hl-0">React</span><span class="hl-1">.</span><span class="hl-0">ContextType</span><span class="hl-1"><</span><span class="hl-6">typeof</span><span class="hl-1"> </span><span class="hl-0">MyContext</span><span class="hl-1">></span>
|
|
32
|
-
</code><button>Copy</button></pre>
|
|
33
|
-
</div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://react.dev/reference/react/Component#context">https://react.dev/reference/react/Component#context</a></p>
|
|
34
|
-
</div><aside class="tsd-sources"><p>Inherited from Component.context</p><ul><li>Defined in node_modules/@types/react/index.d.ts:510</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="props" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>props</span><a href="#props" 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">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Props</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from Component.props</p><ul><li>Defined in node_modules/@types/react/index.d.ts:530</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="refs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">refs</span><a href="#refs" 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">refs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactInstance</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">ReactInstance</span></h5></li></ul></div><div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p><a href="https://legacy.reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs">https://legacy.reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</a></p>
|
|
35
|
-
</div><aside class="tsd-sources"><p>Inherited from Component.refs</p><ul><li>Defined in node_modules/@types/react/index.d.ts:536</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>state</span><a href="#state" 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">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from Component.state</p><ul><li>Defined in node_modules/@types/react/index.d.ts:531</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="unsubscribeTopicId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>unsubscribe<wbr/>Topic<wbr/>Id</span><a href="#unsubscribeTopicId" 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">unsubscribe<wbr/>Topic<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></div><div class="tsd-comment tsd-typography"><p>ID for the subscription to the topic, used to unsubscribe on component unmount.</p>
|
|
36
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/components/ValueDisplay.tsx:98</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="contextType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>context<wbr/>Type</span><a href="#contextType" 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<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Context</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">></span><span class="tsd-signature-symbol"> = EventEmitterContext</span></div><div class="tsd-comment tsd-typography"><p>Defines the context type to subscribe to changes using EventEmitter.</p>
|
|
37
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Component.contextType</p><ul><li>Defined in src/components/ValueDisplay.tsx:94</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="UNSAFE_componentWillMount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span class="deprecated">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Mount</span><a href="#UNSAFE_componentWillMount" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="UNSAFE_componentWillMount.UNSAFE_componentWillMount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Mount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#UNSAFE_componentWillMount.UNSAFE_componentWillMount-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>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
|
38
|
-
Avoid introducing any side-effects or subscriptions in this method.</p>
|
|
39
|
-
<p>This method will not stop working in React 17.</p>
|
|
40
|
-
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
|
41
|
-
prevents this from being invoked.</p>
|
|
42
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p>16.3, use componentDidMount or the constructor instead</p>
|
|
43
|
-
<h4>See</h4><ul>
|
|
44
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</a></li>
|
|
45
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
46
|
-
</ul>
|
|
47
|
-
</div><aside class="tsd-sources"><p>Inherited from Component.UNSAFE_componentWillMount</p><ul><li>Defined in node_modules/@types/react/index.d.ts:733</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="UNSAFE_componentWillReceiveProps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span class="deprecated">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Receive<wbr/>Props</span><a href="#UNSAFE_componentWillReceiveProps" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="UNSAFE_componentWillReceiveProps.UNSAFE_componentWillReceiveProps-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Receive<wbr/>Props</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nextProps</span>, <span class="tsd-kind-parameter">nextContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#UNSAFE_componentWillReceiveProps.UNSAFE_componentWillReceiveProps-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>Called when the component may be receiving new props.
|
|
48
|
-
React may call this even if props have not changed, so be sure to compare new and existing
|
|
49
|
-
props if you only want to handle changes.</p>
|
|
50
|
-
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
|
51
|
-
<p>This method will not stop working in React 17.</p>
|
|
52
|
-
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
|
53
|
-
prevents this from being invoked.</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">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Props</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextContext</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"><h4>Deprecated</h4><p>16.3, use static getDerivedStateFromProps instead</p>
|
|
55
|
-
<h4>See</h4><ul>
|
|
56
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</a></li>
|
|
57
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
58
|
-
</ul>
|
|
59
|
-
</div><aside class="tsd-sources"><p>Inherited from Component.UNSAFE_componentWillReceiveProps</p><ul><li>Defined in node_modules/@types/react/index.d.ts:765</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="UNSAFE_componentWillUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span class="deprecated">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Update</span><a href="#UNSAFE_componentWillUpdate" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="UNSAFE_componentWillUpdate.UNSAFE_componentWillUpdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nextProps</span>, <span class="tsd-kind-parameter">nextState</span>, <span class="tsd-kind-parameter">nextContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#UNSAFE_componentWillUpdate.UNSAFE_componentWillUpdate-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>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
|
60
|
-
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
|
61
|
-
<p>This method will not stop working in React 17.</p>
|
|
62
|
-
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
|
63
|
-
prevents this from being invoked.</p>
|
|
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">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Props</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextContext</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"><h4>Deprecated</h4><p>16.3, use getSnapshotBeforeUpdate instead</p>
|
|
65
|
-
<h4>See</h4><ul>
|
|
66
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</a></li>
|
|
67
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
68
|
-
</ul>
|
|
69
|
-
</div><aside class="tsd-sources"><p>Inherited from Component.UNSAFE_componentWillUpdate</p><ul><li>Defined in node_modules/@types/react/index.d.ts:793</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentDidCatch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>component<wbr/>Did<wbr/>Catch</span><a href="#componentDidCatch" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentDidCatch.componentDidCatch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">component<wbr/>Did<wbr/>Catch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">errorInfo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#componentDidCatch.componentDidCatch-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>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
|
70
|
-
the entire component tree to unmount.</p>
|
|
71
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">errorInfo</span>: <span class="tsd-signature-type">ErrorInfo</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 Component.componentDidCatch</p><ul><li>Defined in node_modules/@types/react/index.d.ts:662</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="componentDidMount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Did<wbr/>Mount</span><a href="#componentDidMount" 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="componentDidMount.componentDidMount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">component<wbr/>Did<wbr/>Mount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#componentDidMount.componentDidMount-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>Upon mounting, the component subscribes to updates on the specified topic if it exists,
|
|
72
|
-
updating its state with the new value when the topic publishes updates.</p>
|
|
73
|
-
</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>Overrides Component.componentDidMount</p><ul><li>Defined in src/components/ValueDisplay.tsx:116</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="componentDidUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Did<wbr/>Update</span><a href="#componentDidUpdate" 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="componentDidUpdate.componentDidUpdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">component<wbr/>Did<wbr/>Update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevProps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#componentDidUpdate.componentDidUpdate-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>If the value prop changes, the component updates its state with the new value.
|
|
74
|
-
This ensures that the component remains in sync with its props.</p>
|
|
75
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">prevProps</span>: <span class="tsd-signature-type">Props</span></span><div class="tsd-comment tsd-typography"><p>The previous properties for comparison to detect changes.</p>
|
|
76
|
-
</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>Overrides Component.componentDidUpdate</p><ul><li>Defined in src/components/ValueDisplay.tsx:131</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentWillMount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span class="deprecated">component<wbr/>Will<wbr/>Mount</span><a href="#componentWillMount" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentWillMount.componentWillMount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">component<wbr/>Will<wbr/>Mount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#componentWillMount.componentWillMount-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>Called immediately before mounting occurs, and before <code>Component#render</code>.
|
|
77
|
-
Avoid introducing any side-effects or subscriptions in this method.</p>
|
|
78
|
-
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
|
79
|
-
prevents this from being invoked.</p>
|
|
80
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
|
81
|
-
<h4>See</h4><ul>
|
|
82
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</a></li>
|
|
83
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
84
|
-
</ul>
|
|
85
|
-
</div><aside class="tsd-sources"><p>Inherited from Component.componentWillMount</p><ul><li>Defined in node_modules/@types/react/index.d.ts:719</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentWillReceiveProps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span class="deprecated">component<wbr/>Will<wbr/>Receive<wbr/>Props</span><a href="#componentWillReceiveProps" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentWillReceiveProps.componentWillReceiveProps-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">component<wbr/>Will<wbr/>Receive<wbr/>Props</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nextProps</span>, <span class="tsd-kind-parameter">nextContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#componentWillReceiveProps.componentWillReceiveProps-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>Called when the component may be receiving new props.
|
|
86
|
-
React may call this even if props have not changed, so be sure to compare new and existing
|
|
87
|
-
props if you only want to handle changes.</p>
|
|
88
|
-
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
|
89
|
-
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
|
90
|
-
prevents this from being invoked.</p>
|
|
91
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Props</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextContext</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"><h4>Deprecated</h4><p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
|
92
|
-
<h4>See</h4><ul>
|
|
93
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</a></li>
|
|
94
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
95
|
-
</ul>
|
|
96
|
-
</div><aside class="tsd-sources"><p>Inherited from Component.componentWillReceiveProps</p><ul><li>Defined in node_modules/@types/react/index.d.ts:748</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="componentWillUnmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>component<wbr/>Will<wbr/>Unmount</span><a href="#componentWillUnmount" 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="componentWillUnmount.componentWillUnmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">component<wbr/>Will<wbr/>Unmount</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#componentWillUnmount.componentWillUnmount-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>Before the component is unmounted, it unsubscribes from the topic to prevent memory leaks
|
|
97
|
-
and unnecessary updates from occurring.</p>
|
|
98
|
-
</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>Overrides Component.componentWillUnmount</p><ul><li>Defined in src/components/ValueDisplay.tsx:143</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentWillUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span class="deprecated">component<wbr/>Will<wbr/>Update</span><a href="#componentWillUpdate" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentWillUpdate.componentWillUpdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">component<wbr/>Will<wbr/>Update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nextProps</span>, <span class="tsd-kind-parameter">nextState</span>, <span class="tsd-kind-parameter">nextContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#componentWillUpdate.componentWillUpdate-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>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
|
99
|
-
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
|
100
|
-
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
|
101
|
-
prevents this from being invoked.</p>
|
|
102
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Props</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextContext</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"><h4>Deprecated</h4><p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
|
103
|
-
<h4>See</h4><ul>
|
|
104
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</a></li>
|
|
105
|
-
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
106
|
-
</ul>
|
|
107
|
-
</div><aside class="tsd-sources"><p>Inherited from Component.componentWillUpdate</p><ul><li>Defined in node_modules/@types/react/index.d.ts:778</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="forceUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>force<wbr/>Update</span><a href="#forceUpdate" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="forceUpdate.forceUpdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">force<wbr/>Update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#forceUpdate.forceUpdate-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from Component.forceUpdate</p><ul><li>Defined in node_modules/@types/react/index.d.ts:527</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getSnapshotBeforeUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>get<wbr/>Snapshot<wbr/>Before<wbr/>Update</span><a href="#getSnapshotBeforeUpdate" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="getSnapshotBeforeUpdate.getSnapshotBeforeUpdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Snapshot<wbr/>Before<wbr/>Update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevProps</span>, <span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#getSnapshotBeforeUpdate.getSnapshotBeforeUpdate-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>Runs before React applies the result of <code>render</code> to the document, and
|
|
108
|
-
returns an object to be given to componentDidUpdate. Useful for saving
|
|
109
|
-
things such as scroll position before <code>render</code> causes changes to it.</p>
|
|
110
|
-
<p>Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated
|
|
111
|
-
lifecycle events from running.</p>
|
|
112
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">prevProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Props</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">prevState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Component.getSnapshotBeforeUpdate</p><ul><li>Defined in node_modules/@types/react/index.d.ts:698</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render</span><a href="#render" 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="render.render-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">render</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><a href="#render.render-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>Renders the component with styling and formatting based on the provided properties and state.
|
|
113
|
-
Supports absolute or relative positioning and scales the display based on the context's dimensions.</p>
|
|
114
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4><p>A styled <code>div</code> element displaying the formatted value.</p>
|
|
115
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Component.render</p><ul><li>Defined in src/components/ValueDisplay.tsx:155</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>State</span><a href="#setState" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="setState.setState-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>State</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="components_ValueDisplay.ValueDisplay.html#setState.setState-1.K">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setState.setState-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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="setState.setState-1.K" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">State</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">state</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevState</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="components_BlocklyEditor.BlocklyEditor.html#setState.setState-1.K">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="components_BlocklyEditor.BlocklyEditor.html#setState.setState-1.K">K</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from Component.setState</p><ul><li>Defined in node_modules/@types/react/index.d.ts:522</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="shouldComponentUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>should<wbr/>Component<wbr/>Update</span><a href="#shouldComponentUpdate" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="shouldComponentUpdate.shouldComponentUpdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">should<wbr/>Component<wbr/>Update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nextProps</span>, <span class="tsd-kind-parameter">nextState</span>, <span class="tsd-kind-parameter">nextContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#shouldComponentUpdate.shouldComponentUpdate-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>Called to determine whether the change in props and state should trigger a re-render.</p>
|
|
116
|
-
<p><code>Component</code> always returns true.
|
|
117
|
-
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
|
118
|
-
props or states have changed.</p>
|
|
119
|
-
<p>If false is returned, <code>Component#render</code>, <code>componentWillUpdate</code>
|
|
120
|
-
and <code>componentDidUpdate</code> will not be called.</p>
|
|
121
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Props</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextContext</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Component.shouldComponentUpdate</p><ul><li>Defined in node_modules/@types/react/index.d.ts:652</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="#context" class="tsd-is-inherited tsd-is-external"><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="#props" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>props</span></a><a href="#refs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refs</span></a><a href="#state" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a><a href="#unsubscribeTopicId" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>Topic<wbr/>Id</span></a><a href="#contextType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Type</span></a><a href="#UNSAFE_componentWillMount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>UNSAFE_<wbr/>component<wbr/>Will<wbr/>Mount</span></a><a href="#UNSAFE_componentWillReceiveProps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>UNSAFE_<wbr/>component<wbr/>Will<wbr/>Receive<wbr/>Props</span></a><a href="#UNSAFE_componentWillUpdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>UNSAFE_<wbr/>component<wbr/>Will<wbr/>Update</span></a><a href="#componentDidCatch" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Catch</span></a><a href="#componentDidMount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a><a href="#componentDidUpdate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Update</span></a><a href="#componentWillMount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Mount</span></a><a href="#componentWillReceiveProps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Receive<wbr/>Props</span></a><a href="#componentWillUnmount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a><a href="#componentWillUpdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Update</span></a><a href="#forceUpdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>force<wbr/>Update</span></a><a href="#getSnapshotBeforeUpdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Snapshot<wbr/>Before<wbr/>Update</span></a><a href="#render" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render</span></a><a href="#setState" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>State</span></a><a href="#shouldComponentUpdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Component<wbr/>Update</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.3</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,51 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValueSimulator | autocore-react - v3.0.3</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.3</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/core_ValueSimulator.html">core/ValueSimulator</a></li><li><a href="core_ValueSimulator.ValueSimulator.html">ValueSimulator</a></li></ul><h1>Class ValueSimulator</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Generates values for simulating data into an HMI.
|
|
2
|
-
Used for demonstration and development testing.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:19</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="core_ValueSimulator.ValueSimulator.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>
|
|
4
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="core_ValueSimulator.ValueSimulator.html#bBit1" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>b<wbr/>Bit1</span></a>
|
|
5
|
-
<a href="core_ValueSimulator.ValueSimulator.html#bBit2" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>b<wbr/>Bit2</span></a>
|
|
6
|
-
<a href="core_ValueSimulator.ValueSimulator.html#dispatch" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dispatch</span></a>
|
|
7
|
-
<a href="core_ValueSimulator.ValueSimulator.html#fRamp1" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Ramp1</span></a>
|
|
8
|
-
<a href="core_ValueSimulator.ValueSimulator.html#fRamp1DirectionUp" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Ramp1<wbr/>Direction<wbr/>Up</span></a>
|
|
9
|
-
<a href="core_ValueSimulator.ValueSimulator.html#fRamp2" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Ramp2</span></a>
|
|
10
|
-
<a href="core_ValueSimulator.ValueSimulator.html#fRamp2DirectionUp" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Ramp2<wbr/>Direction<wbr/>Up</span></a>
|
|
11
|
-
<a href="core_ValueSimulator.ValueSimulator.html#fSin1" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Sin1</span></a>
|
|
12
|
-
<a href="core_ValueSimulator.ValueSimulator.html#fSin1Angle" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Sin1<wbr/>Angle</span></a>
|
|
13
|
-
<a href="core_ValueSimulator.ValueSimulator.html#fSin2" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Sin2</span></a>
|
|
14
|
-
<a href="core_ValueSimulator.ValueSimulator.html#fSin2Angle" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Sin2<wbr/>Angle</span></a>
|
|
15
|
-
<a href="core_ValueSimulator.ValueSimulator.html#iRamp1" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Ramp1</span></a>
|
|
16
|
-
<a href="core_ValueSimulator.ValueSimulator.html#iRamp1DirectionUp" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Ramp1<wbr/>Direction<wbr/>Up</span></a>
|
|
17
|
-
<a href="core_ValueSimulator.ValueSimulator.html#iRamp2" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Ramp2</span></a>
|
|
18
|
-
<a href="core_ValueSimulator.ValueSimulator.html#iRamp2DirectionUp" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Ramp2<wbr/>Direction<wbr/>Up</span></a>
|
|
19
|
-
<a href="core_ValueSimulator.ValueSimulator.html#iSin1" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Sin1</span></a>
|
|
20
|
-
<a href="core_ValueSimulator.ValueSimulator.html#iSin1Angle" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Sin1<wbr/>Angle</span></a>
|
|
21
|
-
<a href="core_ValueSimulator.ValueSimulator.html#iSin2" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Sin2</span></a>
|
|
22
|
-
<a href="core_ValueSimulator.ValueSimulator.html#iSin2Angle" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Sin2<wbr/>Angle</span></a>
|
|
23
|
-
<a href="core_ValueSimulator.ValueSimulator.html#intervalId" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>interval<wbr/>Id</span></a>
|
|
24
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="core_ValueSimulator.ValueSimulator.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a>
|
|
25
|
-
<a href="core_ValueSimulator.ValueSimulator.html#stop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a>
|
|
26
|
-
<a href="core_ValueSimulator.ValueSimulator.html#update" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a>
|
|
27
|
-
<a href="core_ValueSimulator.ValueSimulator.html#updateRamp" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Ramp</span></a>
|
|
28
|
-
<a href="core_ValueSimulator.ValueSimulator.html#updateSin" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Sin</span></a>
|
|
29
|
-
<a href="core_ValueSimulator.ValueSimulator.html#updateTopic" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Topic</span></a>
|
|
30
|
-
</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_ValueSimulator" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Value<wbr/>Simulator</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dispatch</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="core_ValueSimulator.ValueSimulator.html" class="tsd-signature-type tsd-kind-class">ValueSimulator</a><a href="#constructor.new_ValueSimulator" 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>
|
|
31
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dispatch</span>: <a href="../types/core_EventEmitterContext.EmitterDispatchFunction.html" class="tsd-signature-type tsd-kind-type-alias">EmitterDispatchFunction</a></span><div class="tsd-comment tsd-typography"><p>EmitterDispatchFunction Dispatch function from the application's EventEmiterContext.</p>
|
|
32
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="core_ValueSimulator.ValueSimulator.html" class="tsd-signature-type tsd-kind-class">ValueSimulator</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:52</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"><a id="bBit1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>b<wbr/>Bit1</span><a href="#bBit1" 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">b<wbr/>Bit1</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="bBit2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>b<wbr/>Bit2</span><a href="#bBit2" 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">b<wbr/>Bit2</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:22</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="dispatch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>dispatch</span><a href="#dispatch" 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">dispatch</span><span class="tsd-signature-symbol">:</span> <a href="../types/core_EventEmitterContext.EmitterDispatchFunction.html" class="tsd-signature-type tsd-kind-type-alias">EmitterDispatchFunction</a></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:46</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="fRamp1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>f<wbr/>Ramp1</span><a href="#fRamp1" 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">f<wbr/>Ramp1</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:26</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="fRamp1DirectionUp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>f<wbr/>Ramp1<wbr/>Direction<wbr/>Up</span><a href="#fRamp1DirectionUp" 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">f<wbr/>Ramp1<wbr/>Direction<wbr/>Up</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:36</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="fRamp2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>f<wbr/>Ramp2</span><a href="#fRamp2" 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">f<wbr/>Ramp2</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:27</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="fRamp2DirectionUp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>f<wbr/>Ramp2<wbr/>Direction<wbr/>Up</span><a href="#fRamp2DirectionUp" 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">f<wbr/>Ramp2<wbr/>Direction<wbr/>Up</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:37</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="fSin1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>f<wbr/>Sin1</span><a href="#fSin1" 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">f<wbr/>Sin1</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:31</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="fSin1Angle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>f<wbr/>Sin1<wbr/>Angle</span><a href="#fSin1Angle" 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">f<wbr/>Sin1<wbr/>Angle</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="fSin2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>f<wbr/>Sin2</span><a href="#fSin2" 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">f<wbr/>Sin2</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:32</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="fSin2Angle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>f<wbr/>Sin2<wbr/>Angle</span><a href="#fSin2Angle" 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">f<wbr/>Sin2<wbr/>Angle</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:42</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="iRamp1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>i<wbr/>Ramp1</span><a href="#iRamp1" 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">i<wbr/>Ramp1</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:24</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="iRamp1DirectionUp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>i<wbr/>Ramp1<wbr/>Direction<wbr/>Up</span><a href="#iRamp1DirectionUp" 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">i<wbr/>Ramp1<wbr/>Direction<wbr/>Up</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:34</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="iRamp2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>i<wbr/>Ramp2</span><a href="#iRamp2" 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">i<wbr/>Ramp2</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:25</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="iRamp2DirectionUp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>i<wbr/>Ramp2<wbr/>Direction<wbr/>Up</span><a href="#iRamp2DirectionUp" 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">i<wbr/>Ramp2<wbr/>Direction<wbr/>Up</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:35</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="iSin1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>i<wbr/>Sin1</span><a href="#iSin1" 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">i<wbr/>Sin1</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:29</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="iSin1Angle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>i<wbr/>Sin1<wbr/>Angle</span><a href="#iSin1Angle" 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">i<wbr/>Sin1<wbr/>Angle</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:39</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="iSin2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>i<wbr/>Sin2</span><a href="#iSin2" 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">i<wbr/>Sin2</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:30</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="iSin2Angle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>i<wbr/>Sin2<wbr/>Angle</span><a href="#iSin2Angle" 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">i<wbr/>Sin2<wbr/>Angle</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:40</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="intervalId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>interval<wbr/>Id</span><a href="#intervalId" 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">interval<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:44</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start</span><a href="#start" 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="start.start-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#start.start-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>Start simulating values on a tick</p>
|
|
33
|
-
</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"><ul><li>Defined in src/core/ValueSimulator.ts:59</li></ul></aside></li></ul></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><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="stop.stop-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stop</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#stop.stop-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>Stop simulating values.</p>
|
|
34
|
-
</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"><ul><li>Defined in src/core/ValueSimulator.ts:73</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="update" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>update</span><a href="#update" 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-protected"><li class="tsd-signature tsd-anchor-link"><a id="update.update-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#update.update-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>Update and dispatch the values.</p>
|
|
35
|
-
</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"><ul><li>Defined in src/core/ValueSimulator.ts:84</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="updateRamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>update<wbr/>Ramp</span><a href="#updateRamp" 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-protected"><li class="tsd-signature tsd-anchor-link"><a id="updateRamp.updateRamp-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Ramp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">directionUp</span>, <span class="tsd-kind-parameter">max</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</span><a href="#updateRamp.updateRamp-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>Updates the value of a ramp variable, changing its direction when limits are reached.</p>
|
|
36
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The current value of the ramp variable.</p>
|
|
37
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">directionUp</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Indicates if the ramp variable is currently increasing.</p>
|
|
38
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The maximum value for the ramp.</p>
|
|
39
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</span></h4><p>The updated value and direction.</p>
|
|
40
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:122</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="updateSin" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>update<wbr/>Sin</span><a href="#updateSin" 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-protected"><li class="tsd-signature tsd-anchor-link"><a id="updateSin.updateSin-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Sin</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">angle</span>, <span class="tsd-kind-parameter">increment</span>, <span class="tsd-kind-parameter">max</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><a href="#updateSin.updateSin-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>Updates a sine wave value based on the given angle and increments, then calculates the new value and angle.
|
|
41
|
-
This method is useful for scenarios where a sine wave value needs to be progressively updated, such as in animations
|
|
42
|
-
or simulations. The sine of the updated angle is calculated, multiplied by the maximum value to scale it, and both
|
|
43
|
-
the new value and the updated angle are returned.</p>
|
|
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">value</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The current value of the sine wave. This parameter is not directly used in the calculation of the new value,
|
|
45
|
-
but it can be utilized if the method is extended or modified.</p>
|
|
46
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">angle</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The current angle in radians. This is the phase of the sine wave.</p>
|
|
47
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">increment</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The value by which the angle is to be incremented, in radians. This controls the progression of the wave.</p>
|
|
48
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The maximum value (amplitude) of the sine wave. The calculated sine value will be scaled by this factor.</p>
|
|
49
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><p>A tuple where the first element is the new sine wave value and the second element is the updated angle.</p>
|
|
50
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/core/ValueSimulator.ts:147</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="updateTopic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>update<wbr/>Topic</span><a href="#updateTopic" 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-protected"><li class="tsd-signature tsd-anchor-link"><a id="updateTopic.updateTopic-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Topic</span><span class="tsd-signature-symbol">(</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-type">void</span><a href="#updateTopic.updateTopic-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>Dispatch the update for a particular topic.</p>
|
|
51
|
-
</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">value</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"><ul><li>Defined in src/core/ValueSimulator.ts:157</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="#bBit1" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>b<wbr/>Bit1</span></a><a href="#bBit2" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>b<wbr/>Bit2</span></a><a href="#dispatch" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dispatch</span></a><a href="#fRamp1" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Ramp1</span></a><a href="#fRamp1DirectionUp" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Ramp1<wbr/>Direction<wbr/>Up</span></a><a href="#fRamp2" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Ramp2</span></a><a href="#fRamp2DirectionUp" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Ramp2<wbr/>Direction<wbr/>Up</span></a><a href="#fSin1" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Sin1</span></a><a href="#fSin1Angle" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Sin1<wbr/>Angle</span></a><a href="#fSin2" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Sin2</span></a><a href="#fSin2Angle" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>f<wbr/>Sin2<wbr/>Angle</span></a><a href="#iRamp1" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Ramp1</span></a><a href="#iRamp1DirectionUp" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Ramp1<wbr/>Direction<wbr/>Up</span></a><a href="#iRamp2" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Ramp2</span></a><a href="#iRamp2DirectionUp" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Ramp2<wbr/>Direction<wbr/>Up</span></a><a href="#iSin1" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Sin1</span></a><a href="#iSin1Angle" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Sin1<wbr/>Angle</span></a><a href="#iSin2" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Sin2</span></a><a href="#iSin2Angle" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i<wbr/>Sin2<wbr/>Angle</span></a><a href="#intervalId" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>interval<wbr/>Id</span></a><a href="#start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a><a href="#stop" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a><a href="#update" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a><a href="#updateRamp" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Ramp</span></a><a href="#updateSin" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Sin</span></a><a href="#updateTopic" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<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.3</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>
|