@angular/common

PlatformLocation

Class

This class should not be used directly by an application developer. Instead, use Location.

  
    abstract class PlatformLocation {}

This class should not be used directly by an application developer. Instead, use Location.

PlatformLocation encapsulates all calls to DOM APIs, which allows the Router to be platform-agnostic. This means that we can have different implementation of PlatformLocation for the different platforms that Angular supports. For example, @angular/platform-browser provides an implementation specific to the browser environment, while @angular/platform-server provides one suitable for use with server-side rendering.

The PlatformLocation class is used directly by all implementations of {@link LocationStrategy} when they need to interact with the DOM APIs like pushState, popState, etc.

{@link LocationStrategy} in turn is used by the {@link Location} service which is used directly by the {@link Router} in order to navigate between routes. Since all interactions between {@link * Router} / {@link Location} / {@link LocationStrategy} and DOM APIs flow through the PlatformLocation class, they are all platform-agnostic.

getBaseHrefFromDOM

string

@returnsstring

getState

unknown

@returnsunknown

onPopState

VoidFunction

Returns a function that, when executed, removes the popstate event handler.

@paramfnLocationChangeListener

@returnsVoidFunction

onHashChange

VoidFunction

Returns a function that, when executed, removes the hashchange event handler.

@paramfnLocationChangeListener

@returnsVoidFunction

href

string

protocol

string

hostname

string

port

string

pathname

string

search

string

hash

string

replaceState

void

@paramstateany

@paramtitlestring

@paramurlstring

@returnsvoid

pushState

void

@paramstateany

@paramtitlestring

@paramurlstring

@returnsvoid

forward

void

@returnsvoid

back

void

@returnsvoid

historyGo

void

@paramrelativePositionnumber

@returnsvoid