Улучшить эту документацию Просмотреть исходный код $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.

  Примечание: по сравнению с версией без AngularJS 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 и только в браузерах, поддерживающих API истории HTML5 (т.е. методы pushState и replaceState). Если вам нужно поддерживать старые браузеры (например, IE9 или Android < 4.0), не используйте этот метод.

  Параметры

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

  Возвращает

  object

  состояние

События

• $locationChangeStart

  Отправляется перед изменением URL.

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

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

  Тип:

  распространение

  Целевая область:

  корневой область видимости

  Параметры

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

• $locationChangeSuccess

  Отправляется после изменения URL.

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

  Тип:

  распространение

  Целевая область:

  корневой область видимости

  Параметры

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