angular.service.$location.html

<h1>angular.service.$location</h1>
<div class="angular-service-location"><fieldset class="workInProgress"><legend>Work in Progress</legend>
This page is currently being revised. It might be incomplete or contain inaccuracies.</fieldset>
<h2>Description</h2>
<div class="description"><p>Parses the browser location url and makes it available to your application.
Any changes to the url are reflected into $location service and changes to
$location are reflected to url.
Notice that using browser's forward/back buttons changes the $location.</p></div>
<h2>Dependencies</h2>
<ul class="dependencies"><li>$browser</li>
</ul>
<h2>Methods</h2>
<ul class="methods"><li><h3>update(href)</h3>
<div class="update-href-"><p>Update location object
Does not immediately update the browser
Browser is updated at the end of $eval()</p><h4>Parameters</h4>
<ul class="parameters"><li><code ng:non-bindable="">href – {(string|Object)} – </code>
<p>Full href as a string or object with properties</p></li>
</ul>
<h4>Example</h4>
<div class="example"><div ng:non-bindable=""><pre class="brush: js; html-script: true;">scope.$location.update('http://www.angularjs.org/path#hash?search=x');
scope.$location.update({host: 'www.google.com', protocol: 'https'});
scope.$location.update({hashPath: '/path', hashSearch: {a: 'b', x: true}});</pre>
</div>
</div>
</div>
</li>
<li><h3>updateHash(path, search)</h3>
<div class="updatehash-path-search-"><p>Update location hash part</p><h4>Parameters</h4>
<ul class="parameters"><li><code ng:non-bindable="">path – {(string|Object)} – </code>
<p>A hashPath or hashSearch object</p></li>
<li><code ng:non-bindable="">search<i>(optional)</i> – {Object} – </code>
<p>A hashSearch object</p></li>
</ul>
<h4>Example</h4>
<div class="example"><div ng:non-bindable=""><pre class="brush: js; html-script: true;">scope.$location.updateHash('/hp')
  ==&gt; update({hashPath: '/hp'})

scope.$location.updateHash({a: true, b: 'val'})
  ==&gt; update({hashSearch: {a: true, b: 'val'}})

scope.$location.updateHash('/hp', {a: true})
  ==&gt; update({hashPath: '/hp', hashSearch: {a: true}})</pre>
</div>
</div>
</div>
</li>
</ul>
<h2>Properties</h2>
<ul class="properties"><li><h3>href</h3>
<div class="href"></div>
</li>
<li><h3>protocol</h3>
<div class="protocol"></div>
</li>
<li><h3>host</h3>
<div class="host"></div>
</li>
<li><h3>port</h3>
<div class="port"></div>
</li>
<li><h3>path</h3>
<div class="path"></div>
</li>
<li><h3>search</h3>
<div class="search"></div>
</li>
<li><h3>hash</h3>
<div class="hash"></div>
</li>
<li><h3>hashPath</h3>
<div class="hashpath"></div>
</li>
<li><h3>hashSearch</h3>
<div class="hashsearch"></div>
</li>
</ul>
<h2>Example</h2>
<div class="example"><doc:example><doc:source>&lt;a href="#"&gt;clear hash&lt;/a&gt; |
&lt;a href="#myPath?name=misko"&gt;test hash&lt;/a&gt;&lt;br/&gt;
&lt;input type='text' name="$location.hash"/&gt;
&lt;pre&gt;$location = {{$location}}&lt;/pre&gt;</doc:source>
</doc:example>
</div>
</div>