Location

open class Location : OriginSource, URLLike(source)

The Location interface represents the location (URL) of the object it is linked to. Changes done on it are reflected on the object it relates to. Both the Document and Window interface have such a linked Location, accessible via Document.location and Window.location respectively.

MDN Reference

Properties

ancestorOrigins

external val ancestorOrigins: DOMStringList

The ancestorOrigins read-only property of the Location interface is a static DOMStringList containing, in reverse order, the origins of all ancestor browsing contexts of the document associated with the given Location object.

hash

external var hash: String

The hash property of the Location interface is a string containing a "#" followed by the fragment identifier of the location URL. If the URL does not have a fragment identifier, this property contains an empty string, "".

host

external var host: String

The host property of the Location interface is a string containing the host, which is the hostname, and then, if the port of the URL is nonempty, a ":", followed by the port of the URL. If the URL does not have a hostname, this property contains an empty string, "".

hostname

external var hostname: String

The hostname property of the Location interface is a string containing either the domain name or IP address of the location URL. If the URL does not have a hostname, this property contains an empty string, "". IPv4 and IPv6 addresses are normalized, such as stripping leading zeros, and domain names are converted to IDN.

href

external var href: String

The href property of the Location interface is a stringifier that returns a string containing the whole URL, and allows the href to be updated.

origin

external val origin: String

The origin read-only property of the Location interface returns a string containing the Unicode serialization of the origin of the location's URL.

pathname

external var pathname: String

The pathname property of the Location interface is a string containing the path of the URL for the location. If there is no path, pathname will be empty: otherwise, pathname contains an initial '/' followed by the path of the URL, not including the query string or fragment.

port

external var port: String

The port property of the Location interface is a string containing the port number of the location's URL. If the port is the default for the protocol (80 for ws: and http:, 443 for wss: and https:, and 21 for ftp:), this property contains an empty string, "".

protocol

external var protocol: String

The protocol property of the Location interface is a string containing the protocol or scheme of the location's URL, including the final ":".

external var search: String

The search property of the Location interface is a search string, also called a query string, that is a string containing a "?" followed by the parameters of the location's URL. If the URL does not have a search query, this property contains an empty string, "".

Functions

assign

external fun assign(url: String)

external fun assign(url: URL)

The assign() method of the Location interface causes the window to load and display the document at the URL specified. After the navigation occurs, the user can navigate back to the page that called Location.assign() by pressing the "back" button.

reload

external fun reload()

The reload() method of the Location interface reloads the current URL, like the Refresh button.

replace

external fun replace(url: String)

external fun replace(url: URL)

The replace() method of the Location interface replaces the current resource with the one at the provided URL. The difference from the assign() method is that after using replace() the current page will not be saved in session History, meaning the user won't be able to use the back button to navigate to it. Not to be confused with the String method String.prototype.replace().