Permalink
Fetching contributors…
Cannot retrieve contributors at this time
781 lines (778 sloc) 40.3 KB
---
redirect_from: /docs/1.0.0-beta.2/classes/ng2_directives.uisref.html
---
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>UISref | UI-Router</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/typedoctheme.css">
<script src="../assets/js/modernizr.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">UI-Router</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">Externals</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="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/ng2_directives.html">ng2_directives</a>
</li>
<li>
<a href="ng2_directives.uisref.html">UISref</a>
</li>
</ul>
<h1>Class UISref</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>A directive when clicked, initiates a <a href="transition.transition-1.html">Transition</a> to a <a href="state.targetstate.html">TargetState</a>.</p>
</div>
<h3 id="purpose">Purpose</h3>
<p>This directive is applied to anchor tags (<code>&lt;a&gt;</code>) or any other clickable element. It is a state reference (or sref --
similar to an href). When clicked, the directive will transition to that state by calling <a href="state.stateservice.html#go">StateService.go</a>,
and optionally supply state parameter values and transition options.</p>
<p>When this directive is on an anchor tag, it will also add an <code>href</code> attribute to the anchor.</p>
<h3 id="selector">Selector</h3>
<ul>
<li><code>[uiSref]</code>: The directive is created as an attribute on an element, e.g., <code>&lt;a uiSref&gt;&lt;/a&gt;</code></li>
</ul>
<h3 id="inputs">Inputs</h3>
<ul>
<li><p><code>uiSref</code>: the target state&#39;s name, e.g., <code>uiSref=&quot;foostate&quot;</code>. If a component template uses a relative <code>uiSref</code>,
e.g., <code>uiSref=&quot;.child&quot;</code>, the reference is relative to that component&#39;s state.</p>
</li>
<li><p><code>uiParams</code>: any target state parameter values, as an object, e.g., <code>[uiParams]=&quot;{ fooId: bar.fooId }&quot;</code></p>
</li>
<li><p><code>uiOptions</code>: <a href="../interfaces/transition.transitionoptions.html">TransitionOptions</a>, e.g., <code>[uiOptions]=&quot;{ inherit: false }&quot;</code></p>
</li>
</ul>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="lang-html">
<span class="hljs-comment">&lt;!-- Targets bar state' --&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">uiSref</span>=<span class="hljs-string">"bar"</span>&gt;</span>Bar<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
<span class="hljs-comment">&lt;!-- Assume this component's state is "foo".
Relatively targets "foo.child" --&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">uiSref</span>=<span class="hljs-string">".child"</span>&gt;</span>Foo Child<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
<span class="hljs-comment">&lt;!-- Targets "bar" state and supplies parameter value --&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">uiSref</span>=<span class="hljs-string">"bar"</span> [<span class="hljs-attr">uiParams</span>]=<span class="hljs-string">"{ barId: foo.barId }"</span>&gt;</span>Bar {{foo.barId}}<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
<span class="hljs-comment">&lt;!-- Targets "bar" state and parameter, doesn't inherit existing parameters--&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">uiSref</span>=<span class="hljs-string">"bar"</span> [<span class="hljs-attr">uiParams</span>]=<span class="hljs-string">"{ barId: foo.barId }"</span> [<span class="hljs-attr">uiOptions</span>]=<span class="hljs-string">"{ inherit: false }"</span>&gt;</span>Bar {{foo.barId}}<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
</code></pre>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">UISref</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="ng2_directives.uisref.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ng2_directives.uisref.html#_anchoruisref" class="tsd-kind-icon">_anchorUISref</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ng2_directives.uisref.html#_emit" class="tsd-kind-icon">_emit</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ng2_directives.uisref.html#_router" class="tsd-kind-icon">_router</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="ng2_directives.uisref.html#_statessub" class="tsd-kind-icon">_states<wbr>Sub</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ng2_directives.uisref.html#options" class="tsd-kind-icon">options</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ng2_directives.uisref.html#params" class="tsd-kind-icon">params</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ng2_directives.uisref.html#parent" class="tsd-kind-icon">parent</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ng2_directives.uisref.html#state" class="tsd-kind-icon">state</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="ng2_directives.uisref.html#targetstate_" class="tsd-kind-icon">target<wbr>State$</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="ng2_directives.uisref.html#uioptions" class="tsd-kind-icon">ui<wbr>Options</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="ng2_directives.uisref.html#uiparams" class="tsd-kind-icon">ui<wbr>Params</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="ng2_directives.uisref.html#uisref" class="tsd-kind-icon">ui<wbr>Sref</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"><a href="ng2_directives.uisref.html#getoptions" class="tsd-kind-icon">get<wbr>Options</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ng2_directives.uisref.html#go" class="tsd-kind-icon">go</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ng2_directives.uisref.html#ngondestroy" class="tsd-kind-icon">ng<wbr>OnDestroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ng2_directives.uisref.html#ngoninit" class="tsd-kind-icon">ng<wbr>OnInit</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ng2_directives.uisref.html#update" class="tsd-kind-icon">update</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 UISref<span class="tsd-signature-symbol">(</span>_router<span class="tsd-signature-symbol">: </span><a href="core.uirouter.html" class="tsd-signature-type">UIRouter</a>, parent<span class="tsd-signature-symbol">: </span><a href="../interfaces/ng2_directives.parentuiviewinject.html" class="tsd-signature-type">ParentUIViewInject</a>, _anchorUISref<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AnchorUISref</span>, _globals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">UIRouterGlobals</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ng2_directives.uisref.html" class="tsd-signature-type">UISref</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>_router: <a href="core.uirouter.html" class="tsd-signature-type">UIRouter</a></h5>
</li>
<li>
<h5>parent: <a href="../interfaces/ng2_directives.parentuiviewinject.html" class="tsd-signature-type">ParentUIViewInject</a></h5>
</li>
<li>
<h5>_anchorUISref: <span class="tsd-signature-type">AnchorUISref</span></h5>
</li>
<li>
<h5>_globals: <span class="tsd-signature-type">UIRouterGlobals</span></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="ng2_directives.uisref.html" class="tsd-signature-type">UISref</a></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L76">ng2/directives/uiSref.ts:76</a></li>
</ul>
</aside> </li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_anchoruisref" class="tsd-anchor"></a>
<!---->
<!--<h3><span class="tsd-flag ts-flagPrivate">Private</span> _anchorUISref</h3>-->
<!---->
<div class="tsd-signature tsd-kind-icon">_anchorUISref<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AnchorUISref</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L81">ng2/directives/uiSref.ts:81</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_emit" class="tsd-anchor"></a>
<!---->
<!--<h3><span class="tsd-flag ts-flagPrivate">Private</span> _emit</h3>-->
<!---->
<div class="tsd-signature tsd-kind-icon">_emit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L74">ng2/directives/uiSref.ts:74</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_router" class="tsd-anchor"></a>
<!---->
<!--<h3><span class="tsd-flag ts-flagPrivate">Private</span> _router</h3>-->
<!---->
<div class="tsd-signature tsd-kind-icon">_router<span class="tsd-signature-symbol">:</span> <a href="core.uirouter.html" class="tsd-signature-type">UIRouter</a></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L79">ng2/directives/uiSref.ts:79</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_statessub" class="tsd-anchor"></a>
<!---->
<!--<h3><span class="tsd-flag ts-flagPrivate">Private</span> _states<wbr>Sub</h3>-->
<!---->
<div class="tsd-signature tsd-kind-icon">_states<wbr>Sub<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Subscription</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L76">ng2/directives/uiSref.ts:76</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="options" class="tsd-anchor"></a>
<!---->
<!--<h3>options</h3>-->
<!---->
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L71">ng2/directives/uiSref.ts:71</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="params" class="tsd-anchor"></a>
<!---->
<!--<h3>params</h3>-->
<!---->
<div class="tsd-signature tsd-kind-icon">params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L70">ng2/directives/uiSref.ts:70</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="parent" class="tsd-anchor"></a>
<!---->
<!--<h3>parent</h3>-->
<!---->
<div class="tsd-signature tsd-kind-icon">parent<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ng2_directives.parentuiviewinject.html" class="tsd-signature-type">ParentUIViewInject</a></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L80">ng2/directives/uiSref.ts:80</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="state" class="tsd-anchor"></a>
<!---->
<!--<h3>state</h3>-->
<!---->
<div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L69">ng2/directives/uiSref.ts:69</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="targetstate_" class="tsd-anchor"></a>
<!---->
<!--<h3>target<wbr>State$</h3>-->
<!---->
<div class="tsd-signature tsd-kind-icon">target<wbr>State$<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReplaySubject</span><span class="tsd-signature-symbol">&lt;</span><a href="state.targetstate.html" class="tsd-signature-type">TargetState</a><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L73">ng2/directives/uiSref.ts:73</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class">
<a name="uioptions" class="tsd-anchor"></a>
<!---->
<!--<h3>ui<wbr>Options</h3>-->
<!---->
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> <span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="../interfaces/transition.transitionoptions.html" class="tsd-signature-type">TransitionOptions</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>val: <a href="../interfaces/transition.transitionoptions.html" class="tsd-signature-type">TransitionOptions</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 <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L89">ng2/directives/uiSref.ts:89</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class">
<a name="uiparams" class="tsd-anchor"></a>
<!---->
<!--<h3>ui<wbr>Params</h3>-->
<!---->
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> <span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><a href="../interfaces/common.obj.html" class="tsd-signature-type">Obj</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>val: <a href="../interfaces/common.obj.html" class="tsd-signature-type">Obj</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 <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L88">ng2/directives/uiSref.ts:88</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class">
<a name="uisref" class="tsd-anchor"></a>
<!---->
<!--<h3>ui<wbr>Sref</h3>-->
<!---->
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> <span class="tsd-signature-symbol">(</span>val<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">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>val: <span class="tsd-signature-type">string</span></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 <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L87">ng2/directives/uiSref.ts:87</a></li>
</ul>
</aside> </li>
</ul>
</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">
<a name="getoptions" class="tsd-anchor"></a>
<!---->
<!--<h3>get<wbr>Options</h3>-->
<!---->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Options<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L114">ng2/directives/uiSref.ts:114</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="go" class="tsd-anchor"></a>
<!---->
<!--<h3>go</h3>-->
<!---->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">go<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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">boolean</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L123">ng2/directives/uiSref.ts:123</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="ngondestroy" class="tsd-anchor"></a>
<!---->
<!--<h3>ng<wbr>OnDestroy</h3>-->
<!---->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">ng<wbr>OnDestroy<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 <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L96">ng2/directives/uiSref.ts:96</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="ngoninit" class="tsd-anchor"></a>
<!---->
<!--<h3>ng<wbr>OnInit</h3>-->
<!---->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">ng<wbr>OnInit<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 <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L91">ng2/directives/uiSref.ts:91</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="update" class="tsd-anchor"></a>
<!---->
<!--<h3>update</h3>-->
<!---->
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">update<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 <a href="https://github.com/angular-ui/ui-router/blob/4d86ca2/src/ng2/directives/uiSref.ts#L101">ng2/directives/uiSref.ts:101</a></li>
</ul>
</aside> </li>
</ul>
</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="../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/common.html">common</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/common_hof.html">common_<wbr>hof</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/common_predicates.html">common_<wbr>predicates</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/common_strings.html">common_<wbr>strings</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/hooks.html">hooks</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/justjs.html">justjs</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/ng1.html">ng1</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/ng1_directives.html">ng1_<wbr>directives</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/ng1_state_events.html">ng1_<wbr>state_<wbr>events</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/ng2.html">ng2</a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/ng2_directives.html">ng2_<wbr>directives</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/path.html">path</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/state.html">state</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/trace.html">trace</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=" tsd-kind-external-module">
<a href="../modules/view.html">view</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="ng2_directives.uisref.html" class="tsd-kind-icon">UISref</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="ng2_directives.uisref.html#_anchoruisref" class="tsd-kind-icon">_anchorUISref</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="ng2_directives.uisref.html#_emit" class="tsd-kind-icon">_emit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="ng2_directives.uisref.html#_router" class="tsd-kind-icon">_router</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="ng2_directives.uisref.html#_statessub" class="tsd-kind-icon">_states<wbr>Sub</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#options" class="tsd-kind-icon">options</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#parent" class="tsd-kind-icon">parent</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#state" class="tsd-kind-icon">state</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#targetstate_" class="tsd-kind-icon">target<wbr>State$</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#uioptions" class="tsd-kind-icon">ui<wbr>Options</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#uiparams" class="tsd-kind-icon">ui<wbr>Params</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#uisref" class="tsd-kind-icon">ui<wbr>Sref</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#getoptions" class="tsd-kind-icon">get<wbr>Options</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#go" class="tsd-kind-icon">go</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#ngondestroy" class="tsd-kind-icon">ng<wbr>OnDestroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#ngoninit" class="tsd-kind-icon">ng<wbr>OnInit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ng2_directives.uisref.html#update" class="tsd-kind-icon">update</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="ng2_directives.uisrefactive.html" class="tsd-kind-icon">UISref<wbr>Active</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="ng2_directives.uisrefstatus.html" class="tsd-kind-icon">UISref<wbr>Status</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="ng2_directives.uiview.html" class="tsd-kind-icon">UIView</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../interfaces/ng2_directives.inputmapping.html" class="tsd-kind-icon">Input<wbr>Mapping</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/ng2_directives.parentuiviewinject.html" class="tsd-kind-icon">ParentUIView<wbr>Inject</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/ng2_directives.srefstatus.html" class="tsd-kind-icon">Sref<wbr>Status</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../interfaces/ng2_directives.transevt.html" class="tsd-kind-icon">Trans<wbr>Evt</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/ng2_directives.html#reflect" class="tsd-kind-icon">Reflect</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
<a href="../modules/ng2_directives.html#uirouter_directives" class="tsd-kind-icon">UIROUTER_<wbr>DIRECTIVES</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
<a href="../modules/ng2_directives.html#_uirouter_directives" class="tsd-kind-icon">_UIROUTER_<wbr>DIRECTIVES</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/ng2_directives.html#getsrefstatus" class="tsd-kind-icon">get<wbr>Sref<wbr>Status</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/ng2_directives.html#pathmatches" class="tsd-kind-icon">path<wbr>Matches</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/ng2_directives.html#spreadtosubpaths" class="tsd-kind-icon">spread<wbr>ToSub<wbr>Paths</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/ng2_directives.html#inactivestatus" class="tsd-kind-icon">inactive<wbr>Status</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>