RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate.html below:

Locate | API Reference | ArcGIS Maps SDK for JavaScript 4.33

ESM: import Locate from "@arcgis/core/widgets/Locate.js";

CDN: const Locate = await $arcgis.import("@arcgis/core/widgets/Locate.js");

Class: @arcgis/core/widgets/Locate

Since: ArcGIS Maps SDK for JavaScript 4.0

Provides a simple widget that animates the View to the user's current location. The view rotates according to the direction where the tracked device is heading towards. By default the widget looks like the following:

The default heading symbol will display if the device has a speed greater than zero and the browser provides heading information:

The Locate widget is not supported on insecure origins. To use it, switch your application to a secure origin, such as HTTPS. Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that supports Window.isSecureContext.

Known Limitation

The Locate widget does not work concurrently with the Track widget. Only one of the widgets can be used at a time.

You can use the view's DefaultUI to add widgets to the view's user interface via the ui property on the view. The snippet below demonstrates this.

See also

Example

let locateWidget = new Locate({
  view: view,   // Attaches the Locate button to the view
  graphic: new Graphic({
    symbol: { type: "simple-marker" }  // overwrites the default symbol used for the
    // graphic placed at the location of the user when found
  })
});

view.ui.add(locateWidget, "top-right");

Constructors

Locate Constructor new Locate(properties)

Parameter

optional

See the properties for a list of all the properties that may be passed into the constructor.

Example

// typical usage
let locate = new Locate({
  view: view
});

Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties Hide inherited properties

Property Details

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.

Examples

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass Inherited Property declaredClass Stringreadonly Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.: The name of the class. The declared class name is formatted as esri.folder.className.

goToLocationEnabled Property goToLocationEnabled Boolean: Indicates whether the widget should navigate the view to the position and scale of the geolocated result.

Since: ArcGIS Maps SDK for JavaScript 4.8 Locate since 4.0, goToOverride added at 4.8.

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

Example

// The following snippet uses Search but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options = {
    duration: updatedDuration
  };
  return view.goTo(goToParams.target, goToParams.options);
};

The graphic used to show the user's location on the map.

Example

let locateWidget = new Locate({
  viewModel: { // autocasts as new LocateViewModel()
    view: view,  // assigns the locate widget to a view
    graphic: new Graphic({
      symbol: { type: "simple-marker" }  // overwrites the default symbol used for the
      // graphic placed at the location of the user when found
    })
  }
});

Since: ArcGIS Maps SDK for JavaScript 4.28 Locate since 4.0, icon added at 4.28.: Icon displayed in the widget's button.

id Inherited Property id String: The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

Since: ArcGIS Maps SDK for JavaScript 4.8 Locate since 4.0, label added at 4.8.: The widget's default label.

popupEnabled Property popupEnabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.19 Locate since 4.0, popupEnabled added at 4.19.: Indicates whether to display the Popup of the result graphic from the locate() method.

Since: ArcGIS Maps SDK for JavaScript 4.7 Locate since 4.0, scale added at 4.7.

Indicates the scale to set on the view when navigating to the position of the geolocated result once a location is returned from the track event. If a scale value is not explicitly set, then the view will navigate to a default scale of 2500. For 2D views the value should be within the effectiveMinScale and effectiveMaxScale.

Example

reactiveUtils.watch(
  () => mapView.scale,
  (currentScale) => console.log("scale: %s", currentScale)
);

mapView.when(function(){
  // Create an instance of the Locate widget
  let locateWidget = new Locate({
    view: mapView,
    scale: 5000
  });

  // and add it to the view's UI
  mapView.ui.add(locateWidget, "top-left");

  locateWidget.locate();

  locateWidget.on("locate", function(locateEvent){
    console.log(locateEvent);
    console.log("locate: %s", mapView.scale);
  })
});

: A reference to the MapView or SceneView. Set this to link the widget to a specific view.

: The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the LocateViewModel class to access all properties and methods on the widget.

visible Inherited Property visible Boolean

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".

Example

// Hides the widget in the view
widget.visible = false;

Method Overview

Show inherited methods Hide inherited methods

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

cancelLocate Method cancelLocate() Since: ArcGIS Maps SDK for JavaScript 4.9 Locate since 4.0, cancelLocate added at 4.9.: This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device.

classes Inherited Method classes(classNames){String} Since: ArcGIS Maps SDK for JavaScript 4.7 Widget since 4.2, classes added at 4.7.

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Returns

Type Description String The computed class name.

Example

// .tsx syntax showing how to set css classes while rendering the widget

render() {
  const dynamicClasses = {
    [css.flip]: this.flip,
    [css.primary]: this.primary
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicClasses)} />
  );
}

destroy Inherited Method destroy(): Destroys the widget instance.

emit Inherited Method emit(type, event){Boolean} Since: ArcGIS Maps SDK for JavaScript 4.5 Widget since 4.2, emit added at 4.5.

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

The name of the event.

optional

The event payload.

Returns

Type Description Boolean true if a listener was notified

hasEventListener Inherited Method hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Returns

Type Description Boolean Returns true if the class supports the input event.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type Description Boolean Returns true if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

isFulfilled Inherited Method isFulfilled(){Boolean} Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isFulfilled added at 4.19.

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Inherited Method isRejected(){Boolean} Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isRejected added at 4.19.

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been rejected.

isResolved Inherited Method isResolved(){Boolean} Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isResolved added at 4.19.

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been resolved.

locate Method locate(){Promise<Object>}

Animates the view to the user's location.

Returns

Type Description Promise<Object> Resolves to an object with the same specification as the event object defined in the locate event.

Example

let locateWidget = new Locate({
  view: view,
  container: "locateDiv"
});

locateWidget.locate().then(function(){
  // Fires after the user's location has been found
});

on Inherited Method on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Returns

Type Description Object Returns an event handler with a remove() method that should be called to stop listening for the event(s). Property Type Description remove Function When called, removes the listener from the event.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

postInitialize Inherited Method postInitialize(): Executes after widget is ready for rendering.

removeHandles Inherited Method removeHandles(groupKey) Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

render Inherited Method render(){Object}

This method is implemented by subclasses for rendering.

Returns

Type Description Object The rendered virtual node.

renderNow Inherited Method renderNow(): Renders widget to the DOM immediately.

scheduleRender Inherited Method scheduleRender(): Schedules widget rendering. This method is useful for changes affecting the UI.

when Inherited Method when(callback, errback){Promise} Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, when added at 4.19.

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

optional

The function to call when the promise resolves.

optional

The function to execute when the promise fails.

Returns

Type Description Promise Returns a new Promise for the result of callback.

Example

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Event Overview Event Details

Fires after the locate() method is called and succeeds.

Example

locateBtn.on("locate", ({ position }) => {
  const { longitude, latitude } = position.coords;
  console.log(`lat: ${latitude.toFixed(4)}, long: ${longitude.toFixed(4)}`);
})

locate-error Event locate-error

Fires after the locate() method is called and fails.

Property: The Error object that occurred while locating.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4