$location
- 概要
- 依存関係
- absUrl()
- hash(hash)
- host()
- path(path)
- port()
- protocol()
- replace()
- search(search, paramValue)
- url(url, replace)
概要
$locationサービスは、ブラウザのアドレスバー内のURLを解析し(window.locationを基に)、 アプリケーションで利用可能なURLを作成します。 アドレスバー内のURLの変更は、$locationサービスに反映され、 また$locationの変更は、ブラウザのアドレスバーに影響します。
$locationサービス:
- ブラウザアドレスバー内の現在のURLによって、下記の事を行うことが出来ます。
- URLの確認や監視
- URLの変更
- ユーザーが下記の事を行った際に、ブラウザのURLはそれに同期します。
- アドレスバーの変更
- 戻る、または進むボタンのクリック(または、履歴リンクのクリック)
- リンクのクリック
- メソッド(protocol、host、port、path、search、hash)の集合としてURLオブジェクトは表現されます。
詳細については、ガイドの$locationの使用を確認してください。
依存関係
- $browser
- $sniffer
- $rootElement
absUrl()
このメソッドはgetterのみです。
RFC 3968に指定されているルールに沿って全ての区分がエンコードされた完全なURLが返ります。
戻り値 | 説明 |
---|---|
absUrl() | 完全なURLが返ります。 |
hash(hash)
このメソッドには、getterとsetterが存在します。
引数無しで呼ばれると、ハッシュ部分を返します。
引数付きで呼ばれるとハッシュ部分を変更し、$locationを返します。
引数 | 説明 |
---|---|
hash(optional) |
型: 新しいハッシュ部分を指定します。 |
戻り値 | 説明 |
型: ハッシュ部分を返します。(getter時?) |
host()
このメソッドはgetterのみです。
現在のURLのホストを返します。
戻り値 | 説明 |
---|---|
型: 現在のURLのホストが返ります。 |
path(path)
このメソッドには、getterとsetterが存在します。
引数無しで呼ばれると、現在のURLのパスを返します。
引数付きで呼ばれるとパスを変更し、$locationを返します。
注意: パスは常にスラッシュ(/)から始まるべきで、 このメソッドはそれが無ければスラッシュを追加します。
引数 | 説明 |
---|---|
path(optional) |
型: 新しいパスを指定します。 |
戻り値 | 説明 |
型: パスが返ります。 |
port()
このメソッドはgetterのみです。
現在のURLのポートを返します。
戻り値 | 説明 |
---|---|
型: ポートが返ります。 |
protocol()
このメソッドはgetterのみです。
現在のURLのプロトコルが返ります。
戻り値 | 説明 |
---|---|
型: 現在のURLのプロトコルが返ります。 |
replace()
このメソッドが呼ばれると、現在の$digest中の全ての$locationが変更され、 If called, all changes to $location during current $digest will be replacing current history record, instead of adding new one.
search(search, paramValue)
このメソッドにはgetterとsetterが存在します。
引数無しで呼び出されると、現在のURLの検索部分(オブジェクトとして)を返します。
引数付きで呼び出されると、検索部分を変更し、$locationを返します。
引数 | 説明 |
---|---|
search |
型: 新しい検索の引数を、文字列またはハッシュオブジェクトで指定します。 ハッシュオブジェクトは、URL内で重複するものとしてデコードされる値の配列を含めることが出来ます。(翻訳に自信なし) |
paramValue(optional) |
型: もし、search引数が文字列の場合、paramValueはsearch引数を上書きします。 もし値がnullの場合、引数は削除されます。 |
戻り値 | 説明 |
型: searchを返します。 |
url(url, replace)
このメソッドには、getterとsetterが存在します。
引数無しで呼び出されると、URL(例: /path?a=b#hash)が返ります。
引数付きで呼び出されると、パス、検索部分、ハッシュを変更し、$locationを返します。
引数 | 説明 |
---|---|
url(optional) |
型: 新しいURLを、URLの先頭の基礎部分を除いて指定します。(例: /path?a=b#hash) |
replace(optional) |
型: 変更されるパスを指定します。 |
戻り値 | 説明 |
型: URLが返ります。 |
© 2017 Google
Licensed under the Creative Commons Attribution License 3.0.
このページは、ページトップのリンク先のAngularJS公式ドキュメント内のページを翻訳した内容を基に構成されています。 下記の項目を確認し、必要に応じて公式のドキュメントをご確認ください。 もし、誤訳などの間違いを見つけましたら、 @tomofまで教えていただければ幸いです。
- AngularJSの更新頻度が高いため、元のコンテンツと比べてドキュメントの情報が古くなっている可能性があります。
- "訳注:"などの断わりを入れた上で、日本人向けの情報やより分かり易くするための追記を行っている事があります。