mozilla

Revision 463677 of Location

  • Revision slug: Web/API/Location
  • Revision title: Location
  • Revision id: 463677
  • Created:
  • Creator: teoli
  • Is current revision? No
  • Comment

Revision Content

The Location interface represents the location of the object it is linked to. Changes done on it are repercuted by the object it relates to. Both the {{domxref("Document")}} and {{domxref("Window")}} interface have such a linked Location, accessible via {{domxref("Document.location")}} and {{domxref("Window.location")}} respectively.

Properties

The Location interface doesn't inherit any property, but implements those from {{domxref("URLUtils")}}.

{{domxref("URLUtils.href")}}
Is a {{domxref("DOMString")}} containing the whole URL.
{{domxref("URLUtils.protocol")}}
Is a {{domxref("DOMString")}} containing the protocol scheme of the URL, including the final ':'.
{{domxref("URLUtils.host")}}
Is a {{domxref("DOMString")}} containing the host, that is the hostname, a ':', and the port of the URL.
{{domxref("URLUtils.hostname")}}
Is a {{domxref("DOMString")}} containing the domain of the URL.
{{domxref("URLUtils.port")}}
Is a {{domxref("DOMString")}} containing the port number of the URL.
{{domxref("URLUtils.pathname")}}
Is a {{domxref("DOMString")}} containing an initial '/' followed by the path of the URL.
{{domxref("URLUtils.search")}}
Is a {{domxref("DOMString")}} containing a '?' followed by the parameters of the URL.
{{domxref("URLUtils.hash")}}
Is a {{domxref("DOMString")}} containing a '#' followed by the fragment identifier of the URL.

Methods

The Location interface doesn't inherit any method, but implements those from {{domxref("URLUtils")}}.

{{domxref("Location.assign()")}}
Loads the resource at the URL provided in parameter.
{{domxref("Location.replace()")}}
Reloads the resource from the current URL. Its optional unique parameter is a {{domxref("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.
{{domxref("Location.reload()")}}
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 {{domxref("History")}}, meaning the user won't be able to use the back button to navigate to it.
{{domxref("URLUtils.toString()")}}
Returns a {{domxref("DOMString")}} containing the whole URL. It is a synonym for {{domxref("URLUtils.href")}}, though it can't be used to modify the value.

Specifications

Specification Status Comment
{{SpecName('HTML WHATWG', "forms.html#location", "Location")}} {{Spec2('HTML WHATWG')}} No change from {{SpecName("HTML5 W3C")}}.
{{SpecName('HTML5 W3C', "forms.html#location", "Location")}} {{Spec2('HTML5 W3C')}} Initial definition.

Browser compatibility

{{CompatibilityTable}}

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support {{CompatVersionUnknown}} {{CompatVersionUnknown}} {{CompatVersionUnknown}} {{CompatVersionUnknown}} {{CompatVersionUnknown}}
origin on Windows.location {{CompatUnknown}} {{CompatGeckoDesktop("21")}} {{CompatUnknown}} {{CompatUnknown}} {{CompatUnknown}}
origin on Document.location {{CompatUnknown}} {{CompatNo}} {{CompatUnknown}} {{CompatUnknown}} {{CompatUnknown}}
Feature Android Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support {{CompatVersionUnknown}} {{CompatVersionUnknown}} {{CompatVersionUnknown}} {{CompatVersionUnknown}} {{CompatVersionUnknown}}
origin on Windows.location {{CompatUnknown}} {{CompatGeckoMobile("21")}} {{CompatUnknown}} {{CompatUnknown}} {{CompatUnknown}}
origin on Document.location {{CompatUnknown}} {{CompatNo}} {{CompatUnknown}} {{CompatUnknown}} {{CompatUnknown}}

See also

  • Two methods creating such an object: {{domxref("Window.location")}} and {{domxref("Document.location")}}.
 

Revision Source

<p>The <code>Location</code> interface represents the location of the object it is linked to. Changes done on it are repercuted by the object it relates to. Both the {{domxref("Document")}} and {{domxref("Window")}} interface have such a linked <code>Location</code>, accessible via {{domxref("Document.location")}} and {{domxref("Window.location")}} respectively.</p>
<h2 id="Properties">Properties</h2>
<p><em>The <code>Location</code></em><em> interface doesn't inherit any property, but implements those from {{domxref("URLUtils")}}.</em></p>
<dl>
  <dt>
    {{domxref("URLUtils.href")}}</dt>
  <dd>
    Is a {{domxref("DOMString")}} containing the whole URL.</dd>
  <dt>
    {{domxref("URLUtils.protocol")}}</dt>
  <dd>
    Is a {{domxref("DOMString")}} containing the protocol scheme of the URL, including the final <code>':'</code>.</dd>
  <dt>
    {{domxref("URLUtils.host")}}</dt>
  <dd>
    Is a {{domxref("DOMString")}} containing the host, that is the <em>hostname</em>, a <code>':'</code>, and the <em>port</em> of the URL.</dd>
  <dt>
    {{domxref("URLUtils.hostname")}}</dt>
  <dd>
    Is a {{domxref("DOMString")}} containing the domain of the URL.</dd>
  <dt>
    {{domxref("URLUtils.port")}}</dt>
  <dd>
    Is a {{domxref("DOMString")}} containing the port number of the URL.</dd>
  <dt>
    {{domxref("URLUtils.pathname")}}</dt>
  <dd>
    Is a {{domxref("DOMString")}} containing an initial <code>'/'</code> followed by the path of the URL.</dd>
  <dt>
    {{domxref("URLUtils.search")}}</dt>
  <dd>
    Is a {{domxref("DOMString")}} containing a <code>'?'</code> followed by the parameters of the URL.</dd>
  <dt>
    {{domxref("URLUtils.hash")}}</dt>
  <dd>
    Is a {{domxref("DOMString")}} containing a <code>'#'</code> followed by the fragment identifier of the URL.</dd>
</dl>
<h2 id="Methods">Methods</h2>
<p><em>The <code>Location</code></em><em> interface doesn't inherit any method<em>, but implements those from {{domxref("URLUtils")}}</em>.</em></p>
<dl>
  <dt>
    {{domxref("Location.assign()")}}</dt>
  <dd>
    Loads the resource at the URL provided in parameter.</dd>
  <dt>
    {{domxref("Location.replace()")}}</dt>
  <dd>
    Reloads the resource from the current URL. Its optional unique parameter is a {{domxref("Boolean")}}, which, when it is <code>true</code>, causes the page to always be reloaded from the server. If it is <code>false</code> or not specified, the browser may reload the page from its cache.</dd>
  <dt>
    {{domxref("Location.reload()")}}</dt>
  <dd>
    Replaces the current resource with the one at the provided URL. The difference from the <code>assign()</code> method is that after using <code>replace()</code> the current page will not be saved in session {{domxref("History")}}, meaning the user won't be able to use the <em>back</em> button to navigate to it.</dd>
  <dt>
    {{domxref("URLUtils.toString()")}}</dt>
  <dd>
    Returns a {{domxref("DOMString")}} containing the whole URL. It is a synonym for {{domxref("URLUtils.href")}}, though it can't be used to modify the value.</dd>
</dl>
<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
  <tbody>
    <tr>
      <th scope="col">Specification</th>
      <th scope="col">Status</th>
      <th scope="col">Comment</th>
    </tr>
    <tr>
      <td>{{SpecName('HTML WHATWG', "forms.html#location", "Location")}}</td>
      <td>{{Spec2('HTML WHATWG')}}</td>
      <td>No change from {{SpecName("HTML5 W3C")}}.</td>
    </tr>
    <tr>
      <td>{{SpecName('HTML5 W3C', "forms.html#location", "Location")}}</td>
      <td>{{Spec2('HTML5 W3C')}}</td>
      <td>Initial definition.</td>
    </tr>
  </tbody>
</table>
<h2 id="Browser_compatibility">Browser compatibility</h2>
<p>{{CompatibilityTable}}</p>
<div id="compat-desktop">
  <table class="compat-table">
    <tbody>
      <tr>
        <th>Feature</th>
        <th>Chrome</th>
        <th>Firefox (Gecko)</th>
        <th>Internet Explorer</th>
        <th>Opera</th>
        <th>Safari (WebKit)</th>
      </tr>
      <tr>
        <td>Basic support</td>
        <td>{{CompatVersionUnknown}}</td>
        <td>{{CompatVersionUnknown}}</td>
        <td>{{CompatVersionUnknown}}</td>
        <td>{{CompatVersionUnknown}}</td>
        <td>{{CompatVersionUnknown}}</td>
      </tr>
      <tr>
        <td><code>origin</code> on <code>Windows.location</code></td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatGeckoDesktop("21")}}</td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatUnknown}}</td>
      </tr>
      <tr>
        <td><code>origin</code> on <code>Document.location</code></td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatNo}}</td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatUnknown}}</td>
      </tr>
    </tbody>
  </table>
</div>
<div id="compat-mobile">
  <table class="compat-table">
    <tbody>
      <tr>
        <th>Feature</th>
        <th>Android</th>
        <th>Firefox Mobile (Gecko)</th>
        <th>IE Phone</th>
        <th>Opera Mobile</th>
        <th>Safari Mobile</th>
      </tr>
      <tr>
        <td>Basic support</td>
        <td>{{CompatVersionUnknown}}</td>
        <td>{{CompatVersionUnknown}}</td>
        <td>{{CompatVersionUnknown}}</td>
        <td>{{CompatVersionUnknown}}</td>
        <td>{{CompatVersionUnknown}}</td>
      </tr>
      <tr>
        <td><code>origin</code> on <code>Windows.location</code></td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatGeckoMobile("21")}}</td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatUnknown}}</td>
      </tr>
      <tr>
        <td><code>origin</code> on <code>Document.location</code></td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatNo}}</td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatUnknown}}</td>
        <td>{{CompatUnknown}}</td>
      </tr>
    </tbody>
  </table>
</div>
<h2 id="See_also">See also</h2>
<ul>
  <li>Two methods creating such an object: {{domxref("Window.location")}} and {{domxref("Document.location")}}.</li>
</ul>
<dl>
  <dt>
    &nbsp;</dt>
</dl>
Revert to this revision