npm - @realsee/five - Versions diffs - 6.2.0-alpha.1 → 6.2.0-alpha.2 - Mend

@realsee/five 6.2.0-alpha.1 → 6.2.0-alpha.2

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.

Files changed (390) hide show

package/docs/functions/react.useFiveSceneEffect.html CHANGED Viewed

@@ -1,5 +1,6 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveSceneEffect | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.useFiveSceneEffect.html">useFiveSceneEffect</a></li></ul><h1>Function useFiveSceneEffect</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveSceneEffect" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Scene<wbr/>Effect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">deps</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="#useFiveSceneEffect" 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>Five React Hooks: 操作 Five 的 Scene</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</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-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>获取 Five 的 Scene 的回调函数</p>
-</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</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 class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="../classes/five.Scene.html" class="tsd-signature-type tsd-kind-class">Scene</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4></li></ul></li></ul></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">DependencyList</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>Example</h4><pre><code><span class="hl-0">useFiveSceneEffect</span><span class="hl-1">(</span><span class="hl-4">scene</span><span class="hl-1"> </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">// object is a THREE.Object3D</span><br/><span class="hl-1"> </span><span class="hl-4">scene</span><span class="hl-1">.</span><span class="hl-0">add</span><span class="hl-1">(</span><span class="hl-4">object</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">scene</span><span class="hl-1">.</span><span class="hl-0">remove</span><span class="hl-1">(</span><span class="hl-4">object</span><span class="hl-1">); </span><span class="hl-5">// 析构函数</span><br/><span class="hl-1">});</span>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveSceneEffect | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.useFiveSceneEffect.html">useFiveSceneEffect</a></li></ul><h1>Function useFiveSceneEffect</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveSceneEffect" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Scene<wbr/>Effect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">deps</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="#useFiveSceneEffect" 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>Five React Hooks: 操作 Five 的 Scene</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="../classes/five.Scene.html" class="tsd-signature-type tsd-kind-class">Scene</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</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-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>获取 Five 的 Scene 的回调函数</p>
+</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</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 class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="../classes/five.Scene.html" class="tsd-signature-type tsd-kind-class">Scene</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4></li></ul></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">DependencyList</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 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">useFiveSceneEffect</span><span class="hl-1">(</span><span class="hl-4">scene</span><span class="hl-1"> </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">// object is a THREE.Object3D</span><br/><span class="hl-1"> </span><span class="hl-4">scene</span><span class="hl-1">.</span><span class="hl-0">add</span><span class="hl-1">(</span><span class="hl-4">object</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">scene</span><span class="hl-1">.</span><span class="hl-0">remove</span><span class="hl-1">(</span><span class="hl-4">object</span><span class="hl-1">); </span><span class="hl-5">// 析构函数</span><br/><span class="hl-1">});</span>
 </code><button>Copy</button></pre>
-</div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveSceneEffect.ts:17</li></ul></aside></li></ul></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-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></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></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+</div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveSceneEffect.ts:17</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/functions/react.useFiveState.html CHANGED Viewed

	@@ -1 +1 @@
1	- <!DOCTYPE html><html class="default" lang="en"><head><meta ~~charSet~~="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveState \| 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.useFiveState.html">useFiveState</a></li></ul><h1>Function useFiveState</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveState" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>State</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>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">, </span>setState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span>, <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol"~~>?</~~span>, <span class="tsd-kind-parameter">userAction</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 class="tsd-signature-symbol">]</span><a href="#useFiveState" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">, </span>setState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span>, <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol"~~>?</~~span>, <span class="tsd-kind-parameter">userAction</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 class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveState.ts:19</li></ul></aside></li></ul></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-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></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></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1	+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveState \| 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.useFiveState.html">useFiveState</a></li></ul><h1>Function useFiveState</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveState" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>State</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>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">, </span>setState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><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-kind-parameter">prevState</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><a href="#useFiveState" 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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">, </span>setState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><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-kind-parameter">prevState</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveState.ts:19</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/functions/react.useFiveWork.html CHANGED Viewed

@@ -1,8 +1,10 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveWork | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.useFiveWork.html">useFiveWork</a></li></ul><h1>Function useFiveWork</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveWork" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Work</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>works<span class="tsd-signature-symbol">: </span><a href="../types/five.Works.html" class="tsd-signature-type tsd-kind-type-alias">Works</a><span class="tsd-signature-symbol">, </span>loadWork<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">work</span>, <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><a href="#useFiveWork" 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>Five React Hooks: 获取/设置当前的 Work</p>
-</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>works<span class="tsd-signature-symbol">: </span><a href="../types/five.Works.html" class="tsd-signature-type tsd-kind-type-alias">Works</a><span class="tsd-signature-symbol">, </span>loadWork<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">work</span>, <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span></h4><p>[ work: 获取当前的 Work, loadWork: 设置 Work ]</p>
-<div class="tsd-comment tsd-typography"><h4>Function</h4><p>loadWork</p>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveWork | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.useFiveWork.html">useFiveWork</a></li></ul><h1>Function useFiveWork</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveWork" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Work</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>works<span class="tsd-signature-symbol">: </span><a href="../types/five.Works.html" class="tsd-signature-type tsd-kind-type-alias">Works</a><span class="tsd-signature-symbol">, </span>loadWork<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">work</span><span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol"> | </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span>, <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;inherit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initial&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;offset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/five.FiveLoadOptions.html" class="tsd-signature-type tsd-kind-interface">FiveLoadOptions</a>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><a href="#useFiveWork" 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>Five React Hooks: 获取/设置当前的 Work</p>
+</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>works<span class="tsd-signature-symbol">: </span><a href="../types/five.Works.html" class="tsd-signature-type tsd-kind-type-alias">Works</a><span class="tsd-signature-symbol">, </span>loadWork<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">work</span><span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol"> | </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span>, <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;inherit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initial&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;offset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/five.FiveLoadOptions.html" class="tsd-signature-type tsd-kind-interface">FiveLoadOptions</a>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span></h4><p>[ work: 获取当前的 Work, loadWork: 设置 Work ]</p>
+<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Function" class="tsd-anchor"></a>Function<a href="#Function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>loadWork</p>
 <pre><code><span class="hl-4">加载</span><span class="hl-1"> </span><span class="hl-4">Work</span><span class="hl-1"> </span><span class="hl-4">数据</span><br/><span class="hl-5">// param work Work 数据</span><br/><span class="hl-5">// param state 初始化姿态</span><br/><span class="hl-5">//  - &quot;inherit&quot; 使用当前姿态</span><br/><span class="hl-5">//  - &quot;initial&quot; 使用 Work 数据中的 initial 姿态</span><br/><span class="hl-5">//  - State 自定义姿态</span><br/><span class="hl-5">// param duration 切换时间</span><br/><span class="hl-1">(</span><span class="hl-4">work</span><span class="hl-1">: </span><span class="hl-8">Work</span><span class="hl-1">, </span><span class="hl-4">state</span><span class="hl-1">?: </span><span class="hl-2">&quot;inherit&quot;</span><span class="hl-1"> | </span><span class="hl-2">&quot;initial&quot;</span><span class="hl-1"> | </span><span class="hl-8">Partial</span><span class="hl-1">&lt;</span><span class="hl-8">Omit</span><span class="hl-1">&lt;</span><span class="hl-8">State</span><span class="hl-1">, </span><span class="hl-2">&quot;offset&quot;</span><span class="hl-1">&gt;&gt;, </span><span class="hl-4">duration</span><span class="hl-1">?: </span><span class="hl-8">number</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-6">void</span>
 </code><button>Copy</button></pre>
-<h4>Example</h4><pre><code><span class="hl-6">const</span><span class="hl-1"> [ </span><span class="hl-7">work</span><span class="hl-1">, </span><span class="hl-7">loadWork</span><span class="hl-1"> ] = </span><span class="hl-4">useFiveWork</span><span class="hl-1">;</span>
+<h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> [ </span><span class="hl-7">work</span><span class="hl-1">, </span><span class="hl-7">loadWork</span><span class="hl-1"> ] = </span><span class="hl-4">useFiveWork</span><span class="hl-1">;</span>
 </code><button>Copy</button></pre>
-</div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveWork.ts:28</li></ul></aside></li></ul></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-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></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></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+</div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveWork.ts:28</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/functions/react.withFive.html CHANGED Viewed

	@@ -1 +1 @@
1	- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>withFive \| 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.withFive.html">withFive</a></li></ul><h1>Function withFive</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withFive" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Five</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.F">F</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">features</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><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">Component</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></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">"setState"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"forceUpdate"</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">"refs"</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><a href="#withFive" 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="withFive.F" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">F</span><span class="tsd-signature-keyword"> extends </span><a href="../types/react.FiveInjectionFeature.html" class="tsd-signature-type tsd-kind-type-alias">FiveInjectionFeature</a><span class="tsd-signature-symbol">[]</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">features</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.F">F</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">Component</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></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">"setState"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"forceUpdate"</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">"refs"</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></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="withFive.__type.__type-1"><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">Component</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></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">"setState"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"forceUpdate"</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">"refs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="withFive.__type.__type-1.P" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">P</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/react.PropTypeOfFiveFeatures.html" class="tsd-signature-type tsd-kind-interface">PropTypeOfFiveFeatures</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.F">F</a><span class="tsd-signature-symbol">></span></span></li><li><span><a id="withFive.__type.__type-1.C" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">C</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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">Component</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></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">"setState"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> \| </span><span class="tsd-signature-type">"forceUpdate"</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">"refs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts:545</li></ul></aside></li></ul></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-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></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></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1	+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>withFive \| 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.withFive.html">withFive</a></li></ul><h1>Function withFive</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withFive" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Five</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.F">F</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">features</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><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">Component</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"context"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"state"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"setState"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"render"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillUnmount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidCatch"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"forceUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"props"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"refs"</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><a href="#withFive" 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="withFive.F" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">F</span><span class="tsd-signature-keyword"> extends </span><a href="../types/react.FiveInjectionFeature.html" class="tsd-signature-type tsd-kind-type-alias">FiveInjectionFeature</a><span class="tsd-signature-symbol">[]</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">features</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.F">F</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">Component</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"context"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"state"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"setState"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"render"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillUnmount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidCatch"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"forceUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"props"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"refs"</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></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="withFive.__type.__type-1"><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">Component</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"context"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"state"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"setState"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"render"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillUnmount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidCatch"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"forceUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"props"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"refs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="withFive.__type.__type-1.P" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">P</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/react.PropTypeOfFiveFeatures.html" class="tsd-signature-type tsd-kind-interface">PropTypeOfFiveFeatures</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.F">F</a><span class="tsd-signature-symbol">></span></span></li><li><span><a id="withFive.__type.__type-1.C" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">C</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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">Component</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.P">P</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.withFive.html#withFive.__type.__type-1.C">C</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"context"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"state"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"setState"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"render"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillUnmount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidCatch"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentDidUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"componentWillUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"forceUpdate"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"props"</span><br/><span> </span><span class="tsd-signature-symbol">\| </span><span class="tsd-signature-type">"refs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts:545</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/functions/vue.unsafe__useFiveInject.html CHANGED Viewed

@@ -1,5 +1,5 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>unsafe__useFiveInject | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.unsafe__useFiveInject.html">unsafe__useFiveInject</a></li></ul><h1 class="deprecated">Function unsafe__useFiveInject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="unsafe__useFiveInject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unsafe__use<wbr/>Five<wbr/>Inject</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/five.Five.html" class="tsd-signature-type tsd-kind-class">Five</a><a href="#unsafe__useFiveInject" 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>Five Vue Hooks: 获取 five 实例</p>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>unsafe__useFiveInject | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.unsafe__useFiveInject.html">unsafe__useFiveInject</a></li></ul><h1 class="deprecated">Function unsafe__useFiveInject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="unsafe__useFiveInject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unsafe__use<wbr/>Five<wbr/>Inject</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/five.Five.html" class="tsd-signature-type tsd-kind-class">Five</a><a href="#unsafe__useFiveInject" 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>Five Vue Hooks: 获取 five 实例</p>
 </div><h4 class="tsd-returns-title">Returns <a href="../classes/five.Five.html" class="tsd-signature-type tsd-kind-class">Five</a></h4><p>five 实例</p>
-<div class="tsd-comment tsd-typography"><h4>Description</h4><p>不到万不得已，并不推荐直接使用。</p>
-<h4>Deprecated</h4><p>不到万不得已，并不推荐直接使用。</p>
-</div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/unsafe__useFiveInject.ts:10</li></ul></aside></li></ul></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-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></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></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Description" class="tsd-anchor"></a>Description<a href="#Description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>不到万不得已，并不推荐直接使用。</p>
+<h4 class="tsd-anchor-link"><a id="Deprecated" class="tsd-anchor"></a>Deprecated<a href="#Deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>不到万不得已，并不推荐直接使用。</p>
+</div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/unsafe__useFiveInject.ts:10</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/functions/vue.useFiveAction.html CHANGED Viewed

@@ -1,25 +1,33 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveAction | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.useFiveAction.html">useFiveAction</a></li></ul><h1>Function useFiveAction</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveAction" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Action</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type tsd-kind-interface">FiveActionVueCallbacks</a><a href="#useFiveAction" 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>Five Vue Hooks: 使用 Five 的命令</p>
-</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type tsd-kind-interface">FiveActionVueCallbacks</a></h4><div class="tsd-comment tsd-typography"><h4>Function</h4><p>updateCamera</p>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveAction | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.useFiveAction.html">useFiveAction</a></li></ul><h1>Function useFiveAction</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveAction" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Action</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type tsd-kind-interface">FiveActionVueCallbacks</a><a href="#useFiveAction" 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>Five Vue Hooks: 使用 Five 的命令</p>
+</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type tsd-kind-interface">FiveActionVueCallbacks</a></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Function" class="tsd-anchor"></a>Function<a href="#Function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>updateCamera</p>
 <pre><code><span class="hl-4">移动相机</span><span class="hl-1">。（</span><span class="hl-4">不触发点位移动</span><span class="hl-1">）</span><br/><span class="hl-4">如果动画中途被打断</span><span class="hl-1">（</span><span class="hl-4">用户触发行为</span><span class="hl-1">，</span><span class="hl-4">或者调用</span><span class="hl-1"> </span><span class="hl-4">setState</span><span class="hl-1">, </span><span class="hl-4">load</span><span class="hl-1">, </span><span class="hl-4">changeMode</span><span class="hl-1">）</span><span class="hl-4">的等</span><br/><span class="hl-4">会</span><span class="hl-1"> </span><span class="hl-8">Promise</span><span class="hl-1">.</span><span class="hl-4">reject</span><span class="hl-1">。</span><span class="hl-4">运动完成则</span><span class="hl-1"> </span><span class="hl-8">Promise</span><span class="hl-1">.</span><span class="hl-4">resolve</span><br/><br/><span class="hl-5">// params pose - 相机目标位置</span><br/><span class="hl-5">// params duration - 动画触发的时常</span><br/><span class="hl-5">// params Promise - 是否移动成功</span><br/><span class="hl-0">updateCamera</span><span class="hl-1">(</span><span class="hl-4">pose</span><span class="hl-1">: </span><span class="hl-4">Pose</span><span class="hl-1">, </span><span class="hl-4">duration</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">): </span><span class="hl-8">Promise</span><span class="hl-1">&lt;</span><span class="hl-6">void</span><span class="hl-1">&gt;</span>
 </code><button>Copy</button></pre>
-<h4>Function</h4><p>initBasisLoader</p>
+<h4 class="tsd-anchor-link"><a id="Function-1" class="tsd-anchor"></a>Function<a href="#Function-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>initBasisLoader</p>
 <pre><code><span class="hl-4">初始化</span><span class="hl-1"> </span><span class="hl-4">initBasisLoader</span><br/><span class="hl-4">同初始化的</span><span class="hl-1"> </span><span class="hl-4">initBasisLoader</span><span class="hl-1"> </span><span class="hl-4">参数</span><span class="hl-1">。</span><span class="hl-4">用于初始化</span><span class="hl-1"> </span><span class="hl-4">basisLoader</span><span class="hl-1">。</span><br/><span class="hl-4">basisLoader</span><span class="hl-1"> </span><span class="hl-4">只会初始化一次</span><span class="hl-1">，</span><span class="hl-4">一旦初始化则不会再修改</span><span class="hl-1">。</span><br/><br/><span class="hl-5">// param transcoderResourcePath</span><br/><span class="hl-5">// 如果不设置，使用默认解析器 basis 解析器。</span><br/><span class="hl-5">// 可以传入解析器的 `resourcePath`, 则使用指定的解析器</span><br/><span class="hl-0">initBasisLoader</span><span class="hl-1">(</span><span class="hl-4">transcoderResourcePath</span><span class="hl-1">?: </span><span class="hl-4">string</span><span class="hl-1">): </span><span class="hl-6">void</span><span class="hl-1">,</span>
 </code><button>Copy</button></pre>
-<h4>Function</h4><p>getPixels</p>
+<h4 class="tsd-anchor-link"><a id="Function-2" class="tsd-anchor"></a>Function<a href="#Function-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>getPixels</p>
 <pre><code><span class="hl-4">获取画面中的像素颜色</span><br/><span class="hl-5">// param x - 获取像素区域的起始坐标 x</span><br/><span class="hl-5">// param y - 获取像素区域的起始坐标 y</span><br/><span class="hl-5">// param width - 获取像素区域的宽度</span><br/><span class="hl-5">// param height - 获取像素区域的高度</span><br/><span class="hl-5">// param pixelRatio - 获取区域的像素比</span><br/><span class="hl-5">// returns rgba颜色平铺的 Uint8Array</span><br/><span class="hl-0">getPixels</span><span class="hl-1">(</span><span class="hl-4">x</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">, </span><span class="hl-4">y</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">, </span><span class="hl-4">width</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">, </span><span class="hl-4">height</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">, </span><span class="hl-4">pixelRatio</span><span class="hl-1">?: </span><span class="hl-4">number</span><span class="hl-1">): </span><span class="hl-4">Uint8Array</span><span class="hl-1">,</span>
 </code><button>Copy</button></pre>
-<h4>Function</h4><p>render</p>
+<h4 class="tsd-anchor-link"><a id="Function-3" class="tsd-anchor"></a>Function<a href="#Function-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>render</p>
 <pre><code><span class="hl-4">强制渲染</span><br/><span class="hl-4">调用</span><span class="hl-1"> </span><span class="hl-0">render</span><span class="hl-1">() </span><span class="hl-4">和</span><span class="hl-1"> </span><span class="hl-0">needsRender</span><span class="hl-1">() </span><span class="hl-4">均可在按需渲染时</span><span class="hl-1">，</span><span class="hl-4">使得画面渲染一次</span><br/><span class="hl-4">区别在于</span><span class="hl-1">：</span><br/><span class="hl-1">- </span><span class="hl-0">needsRender</span><span class="hl-1">() </span><span class="hl-4">为在下帧渲染画面</span><br/><span class="hl-1">- </span><span class="hl-0">render</span><span class="hl-1">() </span><span class="hl-4">在当前帧渲染画面</span><br/><span class="hl-4">推荐使用</span><span class="hl-1"> </span><span class="hl-0">needsRender</span><span class="hl-1">(), </span><span class="hl-4">可以更加流畅</span><span class="hl-1">。</span><span class="hl-4">但是如果需要截图等同步操作</span><span class="hl-1">，</span><span class="hl-4">可以使用</span><span class="hl-1"> </span><span class="hl-0">render</span><span class="hl-1">()</span><br/><br/><span class="hl-5">// param callback 渲染完成回调</span><br/><span class="hl-0">render</span><span class="hl-1">(</span><span class="hl-4">callback</span><span class="hl-1">?: () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-6">void</span><span class="hl-1">): </span><span class="hl-6">void</span><span class="hl-1">,</span>
 </code><button>Copy</button></pre>
-<h4>Function</h4><p>needsRender</p>
+<h4 class="tsd-anchor-link"><a id="Function-4" class="tsd-anchor"></a>Function<a href="#Function-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>needsRender</p>
 <pre><code><span class="hl-4">下一帧渲染</span><br/><span class="hl-4">调用</span><span class="hl-1"> </span><span class="hl-0">render</span><span class="hl-1">() </span><span class="hl-4">和</span><span class="hl-1"> </span><span class="hl-0">needsRender</span><span class="hl-1">() </span><span class="hl-4">均可在按需渲染时</span><span class="hl-1">，</span><span class="hl-4">使得画面渲染一次</span><br/><span class="hl-4">区别在于</span><span class="hl-1">：</span><br/><span class="hl-1">- </span><span class="hl-0">needsRender</span><span class="hl-1">() </span><span class="hl-4">为在下帧渲染画面</span><br/><span class="hl-1">- </span><span class="hl-0">render</span><span class="hl-1">() </span><span class="hl-4">在当前帧渲染画面</span><br/><span class="hl-4">推荐使用</span><span class="hl-1"> </span><span class="hl-0">needsRender</span><span class="hl-1">(), </span><span class="hl-4">可以更加流畅</span><span class="hl-1">。</span><span class="hl-4">但是如果需要截图等同步操作</span><span class="hl-1">，</span><span class="hl-4">可以使用</span><span class="hl-1"> </span><span class="hl-0">render</span><span class="hl-1">()</span><br/><span class="hl-0">needsRender</span><span class="hl-1">(): </span><span class="hl-6">void</span><span class="hl-1">,</span>
 </code><button>Copy</button></pre>
-<h4>Function</h4><p>preloadPano</p>
+<h4 class="tsd-anchor-link"><a id="Function-5" class="tsd-anchor"></a>Function<a href="#Function-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>preloadPano</p>
 <pre><code><span class="hl-4">预加载点位图片资源</span><br/><span class="hl-5">// param panoId - 观察点</span><br/><span class="hl-5">// param callback - 加载完成回调, 并传递加载用时。</span><br/><span class="hl-5">// returns 加载完成的 Promise 参数同 callback</span><br/><span class="hl-0">preloadPano</span><span class="hl-1">(</span><span class="hl-4">panoId</span><span class="hl-1">: </span><span class="hl-4">WorkPanoId</span><span class="hl-1">, </span><span class="hl-4">callback</span><span class="hl-1">?: (</span><span class="hl-4">costs</span><span class="hl-1">: </span><span class="hl-8">number</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-6">void</span><span class="hl-1">): </span><span class="hl-8">Promise</span><span class="hl-1">&lt;</span><span class="hl-4">number</span><span class="hl-1">&gt;</span>
 </code><button>Copy</button></pre>
-<h4>Function</h4><p>project2d</p>
+<h4 class="tsd-anchor-link"><a id="Function-6" class="tsd-anchor"></a>Function<a href="#Function-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>project2d</p>
 <pre><code><span class="hl-4">计算三维空间的点对应到屏幕的二维坐标</span><br/><span class="hl-4">调用</span><span class="hl-1"> </span><span class="hl-2">`project2d()`</span><span class="hl-1"> </span><span class="hl-4">和</span><span class="hl-1"> </span><span class="hl-2">`useFiveProject2d()`</span><span class="hl-1"> </span><span class="hl-4">均可用于计算三维空间的点对应到屏幕的二维坐标</span><br/><span class="hl-4">区别在于</span><span class="hl-1">：</span><br/><span class="hl-1">- </span><span class="hl-2">`project2d()`</span><span class="hl-1"> </span><span class="hl-4">只计算一次</span><span class="hl-1">，</span><span class="hl-4">入参改变或</span><span class="hl-1"> </span><span class="hl-4">cameraUpdate</span><span class="hl-1"> </span><span class="hl-4">时</span><span class="hl-1"> </span><span class="hl-4">不会更新值</span><br/><span class="hl-1">- </span><span class="hl-2">`useFiveProject2d()`</span><span class="hl-1"> </span><span class="hl-4">通过</span><span class="hl-1"> </span><span class="hl-4">watch</span><span class="hl-1"> </span><span class="hl-4">监听入参和</span><span class="hl-1"> </span><span class="hl-4">cameraUpdate</span><span class="hl-1"> </span><span class="hl-4">变化</span><span class="hl-1">，</span><span class="hl-4">自动更新返回值</span><br/><span class="hl-0">project2d</span><span class="hl-1">(</span><span class="hl-4">vector3</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-4">Vector3</span><span class="hl-1">, </span><span class="hl-4">testModel</span><span class="hl-1">?: </span><span class="hl-4">boolean</span><span class="hl-1"> ): </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-4">Vector2</span>
 </code><button>Copy</button></pre>
-<h4>Example</h4><pre><code><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">updateCamera</span><span class="hl-1">, </span><span class="hl-7">initBasisLoader</span><span class="hl-1">, </span><span class="hl-7">getPixels</span><span class="hl-1">, </span><span class="hl-7">render</span><span class="hl-1">, </span><span class="hl-7">needsRender</span><span class="hl-1">, </span><span class="hl-7">preloadPano</span><span class="hl-1">, </span><span class="hl-7">project2d</span><span class="hl-1"> } = </span><span class="hl-0">useFiveAction</span><span class="hl-1">();</span>
+<h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">updateCamera</span><span class="hl-1">, </span><span class="hl-7">initBasisLoader</span><span class="hl-1">, </span><span class="hl-7">getPixels</span><span class="hl-1">, </span><span class="hl-7">render</span><span class="hl-1">, </span><span class="hl-7">needsRender</span><span class="hl-1">, </span><span class="hl-7">preloadPano</span><span class="hl-1">, </span><span class="hl-7">project2d</span><span class="hl-1"> } = </span><span class="hl-0">useFiveAction</span><span class="hl-1">();</span>
 </code><button>Copy</button></pre>
-</div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveAction.ts:172</li></ul></aside></li></ul></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-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></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></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+</div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveAction.ts:172</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></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>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>