Улучшить документацию Просмотреть исходный код $location

Зависимости

• $rootElement

Методы

• absUrl();

  Этот метод является только для получения.

  Возвращает полное представление URL с кодированием всех сегментов в соответствии с правилами, указанными в RFC 3986.

  // given URL http://example.com/#/some/path?foo=bar&baz=xoxo
  var absUrl = $location.absUrl();
  // => "http://example.com/#/some/path?foo=bar&baz=xoxo"
  

  Возвращаемое значение

  string

  полный URL

• url([url]);

  Этот метод является методом получения/установки.

  Возвращает URL (например, /path?a=b#hash) при вызове без параметров.

  Изменяет путь, поиск и хеш при вызове с параметром и возвращает $location.

  // given URL http://example.com/#/some/path?foo=bar&baz=xoxo
  var url = $location.url();
  // => "/some/path?foo=bar&baz=xoxo"
  

  Параметры

  Параметр	Тип	Подробности
  url (необязательно)	string	Новый URL без префикса базы (например, /path?a=b#hash)

  Возвращаемое значение

  string

  url

• protocol();

  Этот метод является только для получения.

  Возвращает протокол текущего URL.

  // given URL http://example.com/#/some/path?foo=bar&baz=xoxo
  var protocol = $location.protocol();
  // => "http"
  

  Возвращаемое значение

  string

  протокол текущего URL

• host();

  Этот метод является только для получения.

  Возвращает хост текущего URL.

  Примечание: по сравнению с не-угловой версией location.host, которая возвращает hostname:port, эта возвращает только часть hostname.

  // given URL http://example.com/#/some/path?foo=bar&baz=xoxo
  var host = $location.host();
  // => "example.com"
  
  // given URL http://user:password@example.com:8080/#/some/path?foo=bar&baz=xoxo
  host = $location.host();
  // => "example.com"
  host = location.host;
  // => "example.com:8080"
  

  Возвращаемое значение

  string

  хост текущего URL.

• port();

  Этот метод является только для получения.

  Возвращает порт текущего URL.

  // given URL http://example.com/#/some/path?foo=bar&baz=xoxo
  var port = $location.port();
  // => 80
  

  Возвращаемое значение

  Number

  порт

• path([path]);

  Этот метод является методом получения/установки.

  Возвращает путь текущего URL при вызове без параметров.

  Изменяет путь при вызове с параметром и возвращает $location.

  Примечание: Путь всегда должен начинаться с косой черты (/), этот метод добавит косую черту, если она отсутствует.

  // given URL http://example.com/#/some/path?foo=bar&baz=xoxo
  var path = $location.path();
  // => "/some/path"
  

  Параметры

  Параметр	Тип	Подробности
  path (необязательно)	stringnumber	Новый путь

  Возвращаемое значение

  stringobject

  путь, если вызван без параметров, или $location, если вызван с параметром

• search(search, [paramValue]);

  Этот метод является методом получения/установки.

  Возвращает часть поиска (как объект) текущего URL при вызове без параметров.

  Изменяет часть поиска при вызове с параметром и возвращает $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.search() => {foo: 'yipee', baz: 'xoxo'}
  

  Параметры

  Параметр	Тип	Подробности
  search	stringObject.<string>Object.<Array.<string>>	Новые параметры поиска - строка или объект-хеш. При вызове с одним аргументом метод действует как установщик, устанавливая компонент search объекта $location в указанное значение. Если аргумент является объектом-хешем, содержащим массив значений, эти значения будут закодированы как дублирующиеся параметры поиска в URL.
  paramValue (необязательно)	stringNumberArray.<string>boolean	Если search является строкой или числом, то paramValue переопределит только одно свойство поиска. Если paramValue является массивом, он переопределит свойство компонента search объекта $location, указанное через первый аргумент. Если paramValue является null, свойство, указанное через первый аргумент, будет удалено. Если paramValue является true, свойство, указанное через первый аргумент, будет добавлено без значения и последующего знака равенства.

  Возвращаемое значение

  Object

  Если вызов без аргументов, возвращает проанализированный объект search. Если вызов с одним или несколькими аргументами, возвращает сам объект $location.

• hash([hash]);

  Этот метод является методом получения/установки.

  Возвращает фрагмент хеша при вызове без параметров.

  Изменяет фрагмент хеша при вызове с параметром и возвращает $location.

  // given URL http://example.com/#/some/path?foo=bar&baz=xoxo#hashValue
  var hash = $location.hash();
  // => "hashValue"
  

  Параметры

  Параметр	Тип	Подробности
  hash (необязательно)	stringnumber	Новый фрагмент хеша

  Возвращаемое значение

  string

  хеш

• replace();

  При вызове все изменения $location в текущей $digest заменят текущую запись истории вместо добавления новой.

• state([state]);

  Этот метод является методом получения/установки.

  Возвращает объект состояния истории при вызове без параметров.

  Изменяет объект состояния истории при вызове с одним параметром и возвращает $location. Объект состояния позже передается в pushState или replaceState.

  ПРИМЕЧАНИЕ: Этот метод поддерживается только в режиме HTML5 и только в браузерах, поддерживающих HTML5 History API (т.е. методы pushState и replaceState). Если вам нужно поддерживать старые браузеры (например, IE9 или Android < 4.0), не используйте этот метод.

  Параметры

  Параметр	Тип	Подробности
  state (необязательно)	object	Объект состояния для pushState или replaceState

  Возвращаемое значение

  object

  состояние

События

• $locationChangeStart

  Выдается перед изменением URL.

  Это изменение можно предотвратить, вызвав метод preventDefault события. См. $rootScope.Scope для получения более подробной информации об объекте события. После успешного изменения вызывается $locationChangeSuccess.

  Параметры newState и oldState могут быть определены только в режиме HTML5 и когда браузер поддерживает HTML5 History API.

  Тип:

  broadcasting

  Цель:

  корневой scope

  Параметры

  Параметр	Тип	Подробности
  angularEvent	Object	Синтетический объект события.
  newUrl	string	Новый URL
  oldUrl (необязательно)	string	URL, который был до изменения.
  newState (необязательно)	string	Новый объект состояния истории
  oldState (необязательно)	string	Объект состояния истории, который был до изменения.

• $locationChangeSuccess

  Выдается после изменения URL.

  Параметры newState и oldState могут быть определены только в режиме HTML5 и когда браузер поддерживает HTML5 History API.

  Тип:

  broadcasting

  Цель:

  корневой scope

  Параметры

  Параметр	Тип	Подробности
  angularEvent	Object	Синтетический объект события.
  newUrl	string	Новый URL
  oldUrl (необязательно)	string	URL, который был до изменения.
  newState (необязательно)	string	Новый объект состояния истории
  oldState (необязательно)	string	Объект состояния истории, который был до изменения.