Location class / dart:html Library / Dart API Reference

Location class

Returns a Location object, which contains information about the URL of the document and provides methods for changing that URL. You can also assign to this property to load another URL.

from MDN

@DocsEditable
@DomName('Location')
class Location implements LocationBase native "Location" {

 @DomName('Location.ancestorOrigins')
 @DocsEditable
 @Returns('DomStringList')
 @Creates('DomStringList')
 final List<String> ancestorOrigins;

 @DomName('Location.hash')
 @DocsEditable
 String hash;

 @DomName('Location.host')
 @DocsEditable
 String host;

 @DomName('Location.hostname')
 @DocsEditable
 String hostname;

 @DomName('Location.href')
 @DocsEditable
 String href;

 @DomName('Location.pathname')
 @DocsEditable
 String pathname;

 @DomName('Location.port')
 @DocsEditable
 String port;

 @DomName('Location.protocol')
 @DocsEditable
 String protocol;

 @DomName('Location.search')
 @DocsEditable
 String search;

 @DomName('Location.assign')
 @DocsEditable
 void assign(String url) native;

 @DomName('Location.reload')
 @DocsEditable
 void reload() native;

 @DomName('Location.replace')
 @DocsEditable
 void replace(String url) native;

 @DomName('Location.toString')
 @DocsEditable
 String toString() native;

 @DomName('Location.valueOf')
 @DocsEditable
 Object valueOf() native;


 @DomName('Location.origin')
 String get origin {
   if (JS('bool', '("origin" in #)', this)) {
     return JS('String', '#.origin', this);
   }
   return '${this.protocol}//${this.host}';
 }
}

Extends

Interceptor > Location

Implements

LocationBase

Properties

final List<String> ancestorOrigins #

final List<String> ancestorOrigins

String hash #

the part of the URL that follows the # symbol, including the # symbol.
You can listen for the hashchange event to get notified of changes to the hash in supporting browsers.

from MDN

String hash

final int hashCode #

inherited from Interceptor

Get a hash code for this object.

All objects have hash codes. Hash codes are guaranteed to be the same for objects that are equal when compared using the equality operator ==. Other than that there are no guarantees about the hash codes. They will not be consistent between runs and there are no distribution guarantees.

If a subclass overrides hashCode it should override the equality operator as well to maintain consistency.

docs inherited from Object

int get hashCode => Primitives.objectHashCode(this);

String host #

the host name and port number.

from MDN

String host

String hostname #

the host name (without the port number or square brackets).

from MDN

String hostname

String href #

the entire URL.

from MDN

String href

final String origin #

@DomName('Location.origin')
String get origin {
 if (JS('bool', '("origin" in #)', this)) {
   return JS('String', '#.origin', this);
 }
 return '${this.protocol}//${this.host}';
}

String pathname #

the path (relative to the host).

from MDN

String pathname

String port #

the port number of the URL.

from MDN

String port

String protocol #

the protocol of the URL.

from MDN

String protocol

final Type runtimeType #

inherited from Interceptor

A representation of the runtime type of the object.

docs inherited from Object

Type get runtimeType => getRuntimeType(this);

String search #

the part of the URL that follows the ? symbol, including the ? symbol.

from MDN

String search

Operators

bool operator ==(other) #

inherited from Interceptor

The equality operator.

The default behavior for all Objects is to return true if and only if this and other are the same object.

If a subclass overrides the equality operator it should override the hashCode method as well to maintain consistency.

docs inherited from Object

bool operator ==(other) => identical(this, other);

Methods

void assign(String url) #

Load the document at the provided URL.

from MDN

@DomName('Location.assign')
@DocsEditable
void assign(String url) native;

dynamic noSuchMethod(Invocation invocation) #

inherited from Interceptor

noSuchMethod is invoked when users invoke a non-existant method on an object. The name of the method and the arguments of the invocation are passed to noSuchMethod in an Invocation. If noSuchMethod returns a value, that value becomes the result of the original invocation.

The default behavior of noSuchMethod is to throw a noSuchMethodError.

docs inherited from Object

dynamic noSuchMethod(Invocation invocation) {
 throw new NoSuchMethodError(
     this,
     _symbolToString(invocation.memberName),
     invocation.positionalArguments,
     _symbolMapToStringMap(invocation.namedArguments));
}

void reload() #

Reload the document from the current URL. forceget is a boolean, which, when it is true, causes the page to always be reloaded from the server. If it is false or not specified, the browser may reload the page from its cache.

from MDN

@DomName('Location.reload')
@DocsEditable
void reload() native;

void replace(String url) #

Replace the current document 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.

from MDN

@DomName('Location.replace')
@DocsEditable
void replace(String url) native;

String toString() #

Returns a string representation of this object.

docs inherited from Object

@DomName('Location.toString')
@DocsEditable
String toString() native;

Object valueOf() #

@DomName('Location.valueOf')
@DocsEditable
Object valueOf() native;

This page includes content from the Mozilla Foundation that is graciously licensed under a Creative Commons: Attribution-Sharealike license. Mozilla has no other association with Dart or dartlang.org. We encourage you to improve the web by contributing to The Mozilla Developer Network.

Location class

Extends

Implements

Properties

Code final List<String> ancestorOrigins #

Code String hash #

Code final int hashCode #

Code String host #

Code String hostname #

Code String href #

Code final String origin #

Code String pathname #

Code String port #

Code String protocol #

Code final Type runtimeType #

Code String search #

Operators

Code bool operator ==(other) #

Methods

Code void assign(String url) #

Code dynamic noSuchMethod(Invocation invocation) #

Code void reload() #

Code void replace(String url) #

Code String toString() #

Code Object valueOf() #

final List<String> ancestorOrigins #

String hash #

final int hashCode #

String host #

String hostname #

String href #

final String origin #

String pathname #

String port #

String protocol #

final Type runtimeType #

String search #

bool operator ==(other) #

void assign(String url) #

dynamic noSuchMethod(Invocation invocation) #

void reload() #

void replace(String url) #

String toString() #

Object valueOf() #