Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILocationService

$location - $locationProvider - service in module ng see https://docs.angularjs.org/api/ng/service/$location

Hierarchy

  • ILocationService

Index

Methods

absUrl

  • absUrl(): string
  • Returns string

hash

  • Returns string

  • Parameters

    • newHash: string

    Returns ILocationService

host

  • host(): string
  • Returns string

path

  • Return path of current url

    Returns string

  • 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.

    Parameters

    • path: string

      New path

    Returns ILocationService

port

  • port(): number
  • Returns number

protocol

  • protocol(): string
  • Returns string

replace

  • Returns ILocationService

search

  • Return search part (as object) of current url

    Returns any

  • Change search part when called with parameter and return $location.

    Parameters

    • search: any

      When called with a single argument the method acts as a setter, setting the search component of $location to the specified value.

      If the argument is a hash object containing an array of values, these values will be encoded as duplicate search parameters in the url.

    Returns ILocationService

  • Change search part when called with parameter and return $location.

    Parameters

    • search: string

      New search params

    • paramValue: string | number | string[] | boolean

      If search is a string or a Number, then paramValue will override only a single search property. If paramValue is null, the property specified via the first argument will be deleted. If paramValue is an array, it will override the property of the search component of $location specified via the first argument. If paramValue is true, the property specified via the first argument will be added with no value nor trailing equal sign.

    Returns ILocationService

state

  • Returns any

  • Parameters

    • state: any

    Returns ILocationService

url

  • Returns string

  • Parameters

    • url: string

    Returns ILocationService

Generated using TypeDoc