The $location service parses the URL in the browser address bar (based on the window.location) and makes the URL available to your application. Changes to the URL in the address bar are reflected into $location service and changes to $location are reflected into the browser address bar.
The $location service:
For more information see Developer Guide: Using $location
This method is getter only.
Return full url representation with all segments encoded according to rules specified in RFC 3986.
string |
full url |
This method is getter / setter.
Return url (e.g. /path?a=b#hash
) when called without any parameter.
Change path, search and hash, when called with parameter and return $location
.
Param | Type | Details |
---|---|---|
url (optional) | string | New url without base prefix (e.g. |
string |
url |
This method is getter only.
Return protocol of current url.
string |
protocol of current url |
This method is getter only.
Return host of current url.
string |
host of current url. |
This method is getter only.
Return port of current url.
Number |
port |
This method is getter / setter.
Return path of current url when called without any parameter.
Change path when called with parameter and return $location
.
Note: Path should always begin with forward slash (/), this method will add the forward slash if it is missing.
Param | Type | Details |
---|---|---|
path (optional) | string number | New path |
string |
path |
This method is getter / setter.
Return search part (as object) of current url when called without any parameter.
Change search part when called with parameter and return $location
.
// given url http://example.com/#/some/path?foo=bar&baz=xoxo var searchObject = $location.search(); // => {foo: 'bar', baz: 'xoxo'} // set foo to 'yipee' $location.search('foo', 'yipee'); // => $location
Param | Type | Details |
---|---|---|
search | string Object.<string> Object.<Array.<string>> | New search params - string or hash object. When called with a single argument the method acts as a setter, setting the If the argument is a hash object containing an array of values, these values will be encoded as duplicate search parameters in the url. |
paramValue (optional) | string Number Array.<string> boolean | If If If If |
Object |
If called with no arguments returns the parsed |
This method is getter / setter.
Return hash fragment when called without any parameter.
Change hash fragment when called with parameter and return $location
.
Param | Type | Details |
---|---|---|
hash (optional) | string number | New hash fragment |
string |
hash |
If called, all changes to $location during current $digest
will be replacing current history record, instead of adding new one.
Broadcasted before a URL will change. This change can be prevented by calling preventDefault
method of the event. See $rootScope.Scope
for more details about event object. Upon successful change $locationChangeSuccess is fired.
Broadcasted after a URL was changed.
© 2010–2016 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.2.32/docs/api/ng/service/$location