Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
1026 lines (1025 sloc) 53.6 KB
---
---
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ViewService | @uirouter/react</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/css/uirouter.css">
<script src="../assets/js/modernizr.js"></script>
<script src="../assets/js/reset.js"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">@uirouter/react</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<!--
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
-->
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Internal UI-Router API</label>
<!--
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
-->
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@uirouter/react</a>
</li>
<li>
<a href="../modules/view.html">view</a>
</li>
<li>
<a href="view.viewservice.html">ViewService</a>
</li>
</ul>
<h1>Class ViewService</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The View service</p>
</div>
<p>This service pairs existing <code>ui-view</code> components (which live in the DOM)
with view configs (from the state declaration objects: <a href="../interfaces/state.statedeclaration.html#views">StateDeclaration.views</a>).</p>
<ul>
<li><p>After a successful Transition, the views from the newly entered states are activated via <a href="view.viewservice.html#activateviewconfig">activateViewConfig</a>.
The views from exited states are deactivated via <a href="view.viewservice.html#deactivateviewconfig">deactivateViewConfig</a>.
(See: the <a href="../modules/hooks.html#registeractivateviews">registerActivateViews</a> Transition Hook)</p>
</li>
<li><p>As <code>ui-view</code> components pop in and out of existence, they register themselves using <a href="view.viewservice.html#registeruiview">registerUIView</a>.</p>
</li>
<li><p>When the <a href="view.viewservice.html#sync">sync</a> function is called, the registered <code>ui-view</code>(s) (<a href="../interfaces/view.activeuiview.html">ActiveUIView</a>)
are configured with the matching <a href="../interfaces/view.viewconfig.html">ViewConfig</a>(s)</p>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ViewService</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="view.viewservice.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="view.viewservice.html#_listeners" class="tsd-kind-icon">_listeners</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="view.viewservice.html#_rootcontext" class="tsd-kind-icon">_root<wbr>Context</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="view.viewservice.html#_uiviews" class="tsd-kind-icon">_ui<wbr>Views</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="view.viewservice.html#_viewconfigfactories" class="tsd-kind-icon">_view<wbr>Config<wbr>Factories</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="view.viewservice.html#_viewconfigs" class="tsd-kind-icon">_view<wbr>Configs</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="view.viewservice.html#_rootviewcontext" class="tsd-kind-icon">_root<wbr>View<wbr>Context</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="view.viewservice.html#_viewconfigfactory" class="tsd-kind-icon">_view<wbr>Config<wbr>Factory</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#activateviewconfig" class="tsd-kind-icon">activate<wbr>View<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#active" class="tsd-kind-icon">active</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#available" class="tsd-kind-icon">available</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#createviewconfig" class="tsd-kind-icon">create<wbr>View<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#deactivateviewconfig" class="tsd-kind-icon">deactivate<wbr>View<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#registeruiview" class="tsd-kind-icon">registerUIView</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="view.viewservice.html#sync" class="tsd-kind-icon">sync</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="view.viewservice.html#matches" class="tsd-kind-icon">matches</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="view.viewservice.html#normalizeuiviewtarget" class="tsd-kind-icon">normalizeUIView<wbr>Target</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-parent-kind-class"><a href="view.viewservice.html#_pluginapi" class="tsd-kind-icon">_pluginapi</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<!--
<h3>constructor</h3>
-->
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>View<wbr>Service<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="view.viewservice.html" class="tsd-signature-type">ViewService</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="view.viewservice.html" class="tsd-signature-type">ViewService</a></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:190</li>
</ul>
</aside> </li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_listeners" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _listeners</h3>
-->
<div class="tsd-signature tsd-kind-icon">_listeners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ViewSyncListener[]</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:54</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_rootcontext" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _root<wbr>Context</h3>
-->
<div class="tsd-signature tsd-kind-icon">_root<wbr>Context<span class="tsd-signature-symbol">:</span> <a href="../interfaces/view.viewcontext.html" class="tsd-signature-type">ViewContext</a></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:52</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_uiviews" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _ui<wbr>Views</h3>
-->
<div class="tsd-signature tsd-kind-icon">_ui<wbr>Views<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ActiveUIView[]</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:50</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_viewconfigfactories" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _view<wbr>Config<wbr>Factories</h3>
-->
<div class="tsd-signature tsd-kind-icon">_view<wbr>Config<wbr>Factories<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<div class="tsd-declaration">
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="../modules/view.html#viewconfigfactory" class="tsd-signature-type">ViewConfigFactory</a></h5>
</li>
</ul>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:53</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_viewconfigs" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _view<wbr>Configs</h3>
-->
<div class="tsd-signature tsd-kind-icon">_view<wbr>Configs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ViewConfig[]</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:51</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="_rootviewcontext" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _root<wbr>View<wbr>Context</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">_root<wbr>View<wbr>Context<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">?: </span><a href="../interfaces/view.viewcontext.html" class="tsd-signature-type">ViewContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/view.viewcontext.html" class="tsd-signature-type">ViewContext</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>context: <span class="tsd-flag ts-flagOptional">Optional</span>&nbsp; <a href="../interfaces/view.viewcontext.html" class="tsd-signature-type">ViewContext</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="../interfaces/view.viewcontext.html" class="tsd-signature-type">ViewContext</a></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:194</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="_viewconfigfactory" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _view<wbr>Config<wbr>Factory</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">_view<wbr>Config<wbr>Factory<span class="tsd-signature-symbol">(</span>viewType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, factory<span class="tsd-signature-symbol">: </span><a href="../modules/view.html#viewconfigfactory" class="tsd-signature-type">ViewConfigFactory</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>viewType <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>factory <a href="../modules/view.html#viewconfigfactory" class="tsd-signature-type">ViewConfigFactory</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:198</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="activateviewconfig" class="tsd-anchor"></a>
<!--
<h3>activate<wbr>View<wbr>Config</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">activate<wbr>View<wbr>Config<span class="tsd-signature-symbol">(</span>viewConfig<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.viewconfig.html" class="tsd-signature-type">ViewConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>viewConfig <a href="../interfaces/view.viewconfig.html" class="tsd-signature-type">ViewConfig</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:222</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="active" class="tsd-anchor"></a>
<!--
<h3>active</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any[]</span></li>
<li class="tsd-header">
<p> Returns the list of views on the page containing loaded content. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the list of views on the page containing loaded content.</p>
</div>
</div>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any[]</span></h4>
: <p>Returns an array of fully-qualified view names.</p>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:333</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="available" class="tsd-anchor"></a>
<!--
<h3>available</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">available<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any[]</span></li>
<li class="tsd-header">
<p> Returns the list of views currently available on the page, by fully-qualified name. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the list of views currently available on the page, by fully-qualified name.</p>
</div>
</div>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any[]</span></h4>
: <p>Returns an array of fully-qualified view names.</p>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:324</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="createviewconfig" class="tsd-anchor"></a>
<!--
<h3>create<wbr>View<wbr>Config</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>View<wbr>Config<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathNode[]</span>, decl<span class="tsd-signature-symbol">: </span><a href="../interfaces/state._viewdeclaration.html" class="tsd-signature-type">_ViewDeclaration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ViewConfig[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path <span class="tsd-signature-type">PathNode[]</span></h5>
</li>
<li>
<h5>decl <a href="../interfaces/state._viewdeclaration.html" class="tsd-signature-type">_ViewDeclaration</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ViewConfig[]</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:202</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="deactivateviewconfig" class="tsd-anchor"></a>
<!--
<h3>deactivate<wbr>View<wbr>Config</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">deactivate<wbr>View<wbr>Config<span class="tsd-signature-symbol">(</span>viewConfig<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.viewconfig.html" class="tsd-signature-type">ViewConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-header">
<p> Deactivates a ViewConfig. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Deactivates a ViewConfig.</p>
</div>
<p>This function deactivates a <code>ViewConfig</code>.
After calling <a href="view.viewservice.html#sync">sync</a>, it will un-pair from any <code>ui-view</code> with which it is currently paired.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>viewConfig <a href="../interfaces/view.viewconfig.html" class="tsd-signature-type">ViewConfig</a></h5>
: <div class="tsd-comment tsd-typography">
<p>The ViewConfig view to deregister.</p>
</div>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:217</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="registeruiview" class="tsd-anchor"></a>
<!--
<h3>registerUIView</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">registerUIView<span class="tsd-signature-symbol">(</span>uiView<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
<li class="tsd-header">
<p> Registers a <code>ui-view</code> component </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Registers a <code>ui-view</code> component</p>
</div>
<p>When a <code>ui-view</code> component is created, it uses this method to register itself.
After registration the <a href="view.viewservice.html#sync">sync</a> method is used to ensure all <code>ui-view</code> are configured with the proper <a href="../interfaces/view.viewconfig.html">ViewConfig</a>.</p>
<p>Note: the <code>ui-view</code> component uses the <code>ViewConfig</code> to determine what view should be loaded inside the <code>ui-view</code>,
and what the view&#39;s state context is.</p>
<p>Note: There is no corresponding <code>deregisterUIView</code>.
A <code>ui-view</code> should hang on to the return value of <code>registerUIView</code> and invoke it to deregister itself.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uiView <a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a></h5>
: <div class="tsd-comment tsd-typography">
<p>The metadata for a UIView</p>
</div>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
: <p>a de-registration function used when the view is destroyed.</p>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:298</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="sync" class="tsd-anchor"></a>
<!--
<h3>sync</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">sync<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:228</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="matches" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagStatic">Static</span> matches</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">matches<span class="tsd-signature-symbol">(</span>uiViewsByFqn<span class="tsd-signature-symbol">: </span><a href="../interfaces/common.typedmap.html" class="tsd-signature-type">TypedMap</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a><span class="tsd-signature-symbol">&gt;</span>, uiView<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
<li class="tsd-header">
<p> Given a ui-view and a ViewConfig, determines if they &quot;match&quot;. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Given a ui-view and a ViewConfig, determines if they &quot;match&quot;.</p>
</div>
<p>A ui-view has a fully qualified name (fqn) and a context object. The fqn is built from its overall location in
the DOM, describing its nesting relationship to any parent ui-view tags it is nested inside of.</p>
<p>A ViewConfig has a target ui-view name and a context anchor. The ui-view name can be a simple name, or
can be a segmented ui-view path, describing a portion of a ui-view fqn.</p>
<p>In order for a ui-view to match ViewConfig, ui-view&#39;s $type must match the ViewConfig&#39;s $type</p>
<p>If the ViewConfig&#39;s target ui-view name is a simple name (no dots), then a ui-view matches if:</p>
<ul>
<li>the ui-view&#39;s name matches the ViewConfig&#39;s target name</li>
<li>the ui-view&#39;s context matches the ViewConfig&#39;s anchor</li>
</ul>
<p>If the ViewConfig&#39;s target ui-view name is a segmented name (with dots), then a ui-view matches if:</p>
<ul>
<li>There exists a parent ui-view where:<ul>
<li>the parent ui-view&#39;s name matches the first segment (index 0) of the ViewConfig&#39;s target name</li>
<li>the parent ui-view&#39;s context matches the ViewConfig&#39;s anchor</li>
</ul>
</li>
<li>And the remaining segments (index 1..n) of the ViewConfig&#39;s target name match the tail of the ui-view&#39;s fqn</li>
</ul>
<p>Example:</p>
<p>DOM:</p>
<p><ui-view> <!-- created in the root context (name: "") -->
<ui-view name="foo"> <!-- created in the context named: "A" -->
<ui-view> <!-- created in the context named: "A.B" -->
<ui-view name="bar"> <!-- created in the context named: "A.B.C" -->
</ui-view>
</ui-view>
</ui-view>
</ui-view></p>
<p>uiViews: [
{ fqn: &quot;$default&quot;, creationContext: { name: &quot;&quot; } },
{ fqn: &quot;$default.foo&quot;, creationContext: { name: &quot;A&quot; } },
{ fqn: &quot;$default.foo.$default&quot;, creationContext: { name: &quot;A.B&quot; } }
{ fqn: &quot;$default.foo.$default.bar&quot;, creationContext: { name: &quot;A.B.C&quot; } }
]</p>
<p>These four view configs all match the ui-view with the fqn: &quot;$default.foo.$default.bar&quot;:</p>
<ul>
<li>ViewConfig1: { uiViewName: &quot;bar&quot;, uiViewContextAnchor: &quot;A.B.C&quot; }</li>
<li>ViewConfig2: { uiViewName: &quot;$default.bar&quot;, uiViewContextAnchor: &quot;A.B&quot; }</li>
<li>ViewConfig3: { uiViewName: &quot;foo.$default.bar&quot;, uiViewContextAnchor: &quot;A&quot; }</li>
<li>ViewConfig4: { uiViewName: &quot;$default.foo.$default.bar&quot;, uiViewContextAnchor: &quot;&quot; }</li>
</ul>
<p>Using ViewConfig3 as an example, it matches the ui-view with fqn &quot;$default.foo.$default.bar&quot; because:</p>
<ul>
<li>The ViewConfig&#39;s segmented target name is: [ &quot;foo&quot;, &quot;$default&quot;, &quot;bar&quot; ]</li>
<li>There exists a parent ui-view (which has fqn: &quot;$default.foo&quot;) where:<ul>
<li>the parent ui-view&#39;s name &quot;foo&quot; matches the first segment &quot;foo&quot; of the ViewConfig&#39;s target name</li>
<li>the parent ui-view&#39;s context &quot;A&quot; matches the ViewConfig&#39;s anchor context &quot;A&quot;</li>
</ul>
</li>
<li>And the remaining segments [ &quot;$default&quot;, &quot;bar&quot; ].join(&quot;.&quot;_ of the ViewConfig&#39;s target name match
the tail of the ui-view&#39;s fqn &quot;default.bar&quot;</li>
</ul>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uiViewsByFqn <a href="../interfaces/common.typedmap.html" class="tsd-signature-type">TypedMap</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>uiView <a href="../interfaces/view.activeuiview.html" class="tsd-signature-type">ActiveUIView</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:124</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="normalizeuiviewtarget" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagStatic">Static</span> normalizeUIView<wbr>Target</h3>
-->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">normalizeUIView<wbr>Target<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.viewcontext.html" class="tsd-signature-type">ViewContext</a>, rawViewName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li>
<li class="tsd-header">
<p> Normalizes a view&#39;s name from a state.views configuration block. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Normalizes a view&#39;s name from a state.views configuration block.</p>
</div>
<p>This should be used by a framework implementation to calculate the values for
<a href="../interfaces/state._viewdeclaration.html#_uiviewname">_ViewDeclaration.$uiViewName</a> and <a href="../interfaces/state._viewdeclaration.html#_uiviewcontextanchor">_ViewDeclaration.$uiViewContextAnchor</a>.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>context <a href="../interfaces/view.viewcontext.html" class="tsd-signature-type">ViewContext</a></h5>
: <div class="tsd-comment tsd-typography">
<p>the context object (state declaration) that the view belongs to</p>
</div>
</li>
<li>
<h5>rawViewName: <span class="tsd-flag ts-flagDefault value">Default value</span>&nbsp; <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;&quot;</span></h5>
: <div class="tsd-comment tsd-typography">
<p>the name of the view, as declared in the <a href="../interfaces/state.statedeclaration.html#views">StateDeclaration.views</a></p>
</div>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
: <p>the normalized uiViewName and uiViewContextAnchor that the view targets</p>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>ui<wbr>View<wbr>Context<wbr>Anchor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>ui<wbr>View<wbr>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:157</li>
</ul>
</aside> </li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-class">
<a name="_pluginapi" class="tsd-anchor"></a>
<!--
<h3>_pluginapi</h3>
-->
<div class="tsd-signature tsd-kind-icon">_pluginapi<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:56</li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="_pluginapi._rootviewcontext-1" class="tsd-anchor"></a>
<!--
<h3>_root<wbr>View<wbr>Context</h3>
-->
<div class="tsd-signature tsd-kind-icon">_root<wbr>View<wbr>Context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;this._rootViewContext.bind(this)</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:57</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="_pluginapi._viewconfigfactory-1" class="tsd-anchor"></a>
<!--
<h3>_view<wbr>Config<wbr>Factory</h3>
-->
<div class="tsd-signature tsd-kind-icon">_view<wbr>Config<wbr>Factory<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;this._viewConfigFactory.bind(this)</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:58</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
<a name="_pluginapi._activeviewconfigs" class="tsd-anchor"></a>
<!--
<h3>_active<wbr>View<wbr>Configs</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal">
<li class="tsd-signature tsd-kind-icon">_active<wbr>View<wbr>Configs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ViewConfig[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ViewConfig[]</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:60</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
<a name="_pluginapi._onsync" class="tsd-anchor"></a>
<!--
<h3>_on<wbr>Sync</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal">
<li class="tsd-signature tsd-kind-icon">_on<wbr>Sync<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><a href="../interfaces/view.viewsynclistener.html" class="tsd-signature-type">ViewSyncListener</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>listener <a href="../interfaces/view.viewsynclistener.html" class="tsd-signature-type">ViewSyncListener</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:61</li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
<a name="_pluginapi._registereduiviews" class="tsd-anchor"></a>
<!--
<h3>_registeredUIViews</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal">
<li class="tsd-signature tsd-kind-icon">_registeredUIViews<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ActiveUIView[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ActiveUIView[]</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in .downstream_cache/@uirouter/core/src/view/view.ts:59</li>
</ul>
</aside> </li>
</ul>
</section>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../index.html"><em>@uirouter/react</em></a>
</li>
<li class="label tsd-is-external">
<span>Public API</span>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/components.html">components</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/core.html">core</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/params.html">params</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/react.html">react</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/resolve.html">resolve</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/transition.html">transition</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/url.html">url</a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/view.html">view</a>
</li>
<li class="label tsd-is-external">
<span>Internal UI-<wbr><wbr>Router API</span>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/common.html">common</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/common_hof.html">common_<wbr>hof</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/common_predicates.html">common_<wbr>predicates</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/common_strings.html">common_<wbr>strings</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/hooks.html">hooks</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/path.html">path</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/state.html">state</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/trace.html">trace</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="../modules/vanilla.html">vanilla</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="view.viewservice.html" class="tsd-kind-icon">View<wbr>Service</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="view.viewservice.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="view.viewservice.html#_listeners" class="tsd-kind-icon">_listeners</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="view.viewservice.html#_rootcontext" class="tsd-kind-icon">_root<wbr>Context</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="view.viewservice.html#_uiviews" class="tsd-kind-icon">_ui<wbr>Views</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="view.viewservice.html#_viewconfigfactories" class="tsd-kind-icon">_view<wbr>Config<wbr>Factories</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="view.viewservice.html#_viewconfigs" class="tsd-kind-icon">_view<wbr>Configs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="view.viewservice.html#_rootviewcontext" class="tsd-kind-icon">_root<wbr>View<wbr>Context</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="view.viewservice.html#_viewconfigfactory" class="tsd-kind-icon">_view<wbr>Config<wbr>Factory</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#activateviewconfig" class="tsd-kind-icon">activate<wbr>View<wbr>Config</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#active" class="tsd-kind-icon">active</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#available" class="tsd-kind-icon">available</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#createviewconfig" class="tsd-kind-icon">create<wbr>View<wbr>Config</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#deactivateviewconfig" class="tsd-kind-icon">deactivate<wbr>View<wbr>Config</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#registeruiview" class="tsd-kind-icon">registerUIView</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="view.viewservice.html#sync" class="tsd-kind-icon">sync</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="view.viewservice.html#matches" class="tsd-kind-icon">matches</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="view.viewservice.html#normalizeuiviewtarget" class="tsd-kind-icon">normalizeUIView<wbr>Target</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-class">
<a href="view.viewservice.html#_pluginapi" class="tsd-kind-icon">_pluginapi</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/view.activeuiview.html" class="tsd-kind-icon">ActiveUIView</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/view.viewconfig.html" class="tsd-kind-icon">View<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/view.viewcontext.html" class="tsd-kind-icon">View<wbr>Context</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/view.viewservicepluginapi.html" class="tsd-kind-icon">View<wbr>Service<wbr>PluginAPI</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/view.viewsynclistener.html" class="tsd-kind-icon">View<wbr>Sync<wbr>Listener</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/view.viewtuple.html" class="tsd-kind-icon">View<wbr>Tuple</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/view.html#viewconfigfactory" class="tsd-kind-icon">View<wbr>Config<wbr>Factory</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.io" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>
You can’t perform that action at this time.