Locate

提供一个简单微件，用于将 View 动画定位到用户的当前位置。视图根据被追踪设备前进的方向旋转。默认情况下，微件如下图所示。

locate-button

不安全的来源不支持 Locate 微件。要使用它，请将您的应用程序切换到安全源，例如 HTTPS。请注意，localhost 被认为是“潜在安全的”，可用于在支持 Window.isSecureContext (当前为 Chrome 和 Firefox) 的浏览器中轻松测试。

从 4.2 版本开始，Locate Button 不再显示在不安全的 Web 应用程序中。在 4.1 版本中，这仅适用于 Google Chrome。

已知限制

Locate 微件不能与 Track 微件同时工作。一次只能使用其中一个微件。

如果 View 的空间参考不是 Web Mercator 或 WGS84，则必须重新投影用户的位置以匹配视图的空间参考。这是使用 geosceneConfig 中引用的 geometryService URL 完成的。您可选择性地将 geosceneConfig 中的 geometryServiceUrl 设置为您自己的 geometryService 示例。但是，如果未指定，它将引用默认 portal 实例中托管的服务。有关示例，请参阅 geosceneConfig.geometryServiceUrl。

您可使用视图的 DefaultUI 通过视图上的 ui 属性将微件添加到视图的用户界面。以下代码段演示了这一点。

另请参阅

示例

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");

构造函数

new Locate(properties)

参数

properties Object

optional

有关可能传递给构造函数的所有属性的列表，请参见属性。

示例

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

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。

显示继承属性

隐藏继承属性

类型	描述	类
String\|HTMLElement	包含微件的 DOM 元素的 ID 或节点。更多详情	Widget
String	类的名称。更多详情	Accessor
Object	用于定位的 HTML5 Geolocation Position 选项。更多详情	Locate
Boolean	指示微件是否应将视图导航到地理定位结果的位置和比例。更多详情	Locate
GoToOverride	此函数提供了覆盖 MapView goTo() 或 SceneView goTo() 方法的能力。更多详情	Locate
Graphic	用于在地图上显示用户位置的图形。更多详情	Locate
String	微件的默认 CSS 图标类。更多详情	Locate
String	创建微件时分配给微件的唯一 ID。更多详情	Widget
String	微件的默认的标注。更多详情	Locate
Boolean	指示是否显示 locate() 方法中的结果图形的弹出窗口。更多详情	Locate
Number	指示在从 track 事件返回位置后，导航到地理定位结果的位置时，在视图上设置的比例。更多详情	Locate
Boolean	指示微件是否将自动旋转至用户的方向。更多详情	Locate
MapView\|SceneView	对 MapView 或 SceneView 的引用。更多详情	Locate
LocateViewModel	此微件的视图模型。更多详情	Locate
Boolean	指示微件是否可见。更多详情	Widget

属性详细信息

container String|HTMLElement inherited

包含微件的 DOM 元素的 ID 或节点。此属性只能设置一次。以下示例都是使用微件时的有效用例。

示例

// 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 Stringreadonly inherited 起始版本：GeoScene Maps SDK for JavaScript 4.7

类的名称。声明的类名称格式化为 geoscene.folder.className。

geolocationOptions Object

用于定位的 HTML5 Geolocation Position 选项。详情请参阅 Geolocation API 规范。

默认值：{ maximumAge: 0, timeout: 15000, enableHighAccuracy: true }

goToLocationEnabled Boolean

指示微件是否应将视图导航到地理定位结果的位置和比例。

默认值：true

goToOverride GoToOverride 起始版本：GeoScene Maps SDK for JavaScript 4.8

此函数提供了覆盖 MapView goTo() 或 SceneView goTo() 方法的能力。

另请参阅

示例

// The following snippet uses the Search widget 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);
};

graphic Graphicautocast

用于在地图上显示用户位置的图形。

示例

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
    })
  }
});

iconClass String 起始版本：GeoScene Maps SDK for JavaScript 4.7

微件的默认 CSS 图标类。

id String inherited

创建微件时分配给微件的唯一 ID。如果不是由开发人员设置的，它将默认为容器 Id，或者如果没有容器 ID，则将自动生成。

label String 起始版本：GeoScene Maps SDK for JavaScript 4.8

微件的默认的标注。

popupEnabled Boolean 起始版本：GeoScene Maps SDK for JavaScript 4.19

指示是否显示 locate() 方法中的结果图形的弹出窗口。

默认值：true

另请参阅

Search.popupEnabled

scale Number 起始版本：GeoScene Maps SDK for JavaScript 4.7

指示在从 track 事件返回位置后，导航到地理定位结果的位置时，在视图上设置的比例。如果未明确设置比例值，则视图将导航到默认比例 2500。对于 2D 视图，该值应在 effectiveMinScale 和 effectiveMaxScale 之间。

默认值：null

示例

mapView.watch("scale", function (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);
  })
});

useHeadingEnabled Boolean 起始版本：GeoScene Maps SDK for JavaScript 4.6

指示微件是否将自动旋转至用户的方向。设置为 false 以禁用此行为。

默认值：true

view MapView|SceneView

对 MapView 或 SceneView 的引用。设置此选项可将微件链接到特定视图。

viewModel LocateViewModelautocast

此微件的视图模型。此类包含控制此微件行为的所有逻辑。请参阅 LocateViewModel 类来访问微件上的所有属性和方法。

visible Boolean inherited

指示微件是否可见。

如果为 false，微件将不再呈现在 web 文档中。这可能会影响文档中其他元素或微件的布局。例如，如果此微件是与视图 UI 右上角关联的三个微件中的第一个，则当此微件不可见时，其他微件将重新定位。有关更多信息，请参阅 CSS display 值 "none"。

默认值：true

示例

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

方法概述

显示继承的方法

隐藏继承的方法

返回值类值	描述	类
	添加一个或多个与对象的生命周期相关联的句柄。更多详情	Accessor
	此函数提供了中断和取消以编程方式获取用户设备位置的过程的功能。更多详情	Locate
String	用于为微件的 `class` 属性构建值的实用方法。更多详情	Widget
	销毁微件实例。更多详情	Widget
Boolean	在实例上触发事件。更多详情	Widget
Boolean	指示实例上是否存在与提供的事件名称相匹配的事件监听器。更多详情	Widget
Boolean	如果存在指定的句柄组，则返回 true。更多详情	Accessor
Boolean	`isFulfilled()` 可用于验证创建类的实例是否已完成 (已解决或已拒绝)。更多详情	Widget
Boolean	`isRejected()` 可用于验证创建类的实例是否被拒绝。更多详情	Widget
Boolean	`isResolved()` 可用于验证创建类的实例是否已解决。更多详情	Widget
Promise<Object>	将视图动画化到用户的位置。更多详情	Locate
Object	在实例上注册事件处理程序。更多详情	Widget
	添加一个或多个与微件的生命周期相关联的句柄。更多详情	Widget
	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
	移除对象拥有的句柄组。更多详情	Accessor
Object	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
	立即将微件渲染到 DOM。更多详情	Widget
	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
Promise	一旦创建了类的实例，就可以使用`when()` 。更多详情	Widget

方法详细说明

addHandles(handleOrHandles, groupKey)inherited 起始版本：GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

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

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle []

对象销毁后，标记为要移除的句柄。

groupKey *

optional

标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

cancelLocate() 起始版本：GeoScene Maps SDK for JavaScript 4.9

此函数提供了中断和取消以编程方式获取用户设备位置的过程的功能。

classes(classNames){String}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.7

用于为微件的 class 属性构建值的实用方法。这有助于简化 CSS 类设置。

参数

classNames String|String []|Object

repeatable

类名称。

类型	描述
String	计算的类名。

另请参阅

指南 - 微件开发 (渲染器)

示例

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

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

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

destroy()inherited

销毁微件实例。

emit(type, event){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.5

在实例上触发事件。仅当创建此类的子类时，才应使用此方法。

参数

type String

事件的名称。

event Object

optional

事件有效负载。

类型	描述
Boolean	如果监听器收到通知，则为`true`

hasEventListener(type){Boolean}inherited

指示实例上是否存在与提供的事件名称相匹配的事件监听器。

参数

type String

事件的名称。

类型	描述
Boolean	如果类支持输入事件，则返回 true。

hasHandles(groupKey){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 true。

参数

groupKey *

optional

组键。

类型	描述
Boolean	如果存在指定的句柄组，则返回 `true`。

示例

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

isFulfilled(){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

isFulfilled() 可用于验证创建类的实例是否已完成 (已解决或已拒绝)。如果满足，则返回 true。

类型	描述
Boolean	指示创建类的实例是否已完成 (已解决或已拒绝)。

isRejected(){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

isRejected() 可用于验证创建类的实例是否被拒绝。如果被拒绝，则返回 true。

类型	描述
Boolean	指示创建类的实例是否已被拒绝。

isResolved(){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

isResolved() 可用于验证创建类的实例是否已解决。如果已解决，则返回 true。

类型	描述
Boolean	指示创建类的实例是否已解决。

locate(){Promise<object>}

将视图动画化到用户的位置。

类型	描述
Promise<Object>	解析为与定位事件中定义的事件对象具有相同规范的对象。

示例

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

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

on(type, listener){Object}inherited

在实例上注册事件处理程序。调用此方法将事件与监听器挂钩。

参数

type String|String []

要侦听的事件或者事件数组。

listener Function

事件触发时要调用的函数。

类型描述

Object

返回具有 remove() 方法的事件处理程序，可调用该方法来停止侦听事件。

属性	类型	描述
remove	Function	调用时，从事件中移除侦听器。

示例

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

own(handleOrHandles)inherited 起始版本：GeoScene Maps SDK for JavaScript 4.24

添加一个或多个与微件的生命周期相关联的句柄。当微件被销毁时，将移除句柄。

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

this.own(handle); // Handle gets removed when the widget is destroyed.

参数

handleOrHandles WatchHandle|WatchHandle []

微件销毁后，标记为要移除的句柄。

postInitialize()inherited

此方法主要由开发人员在实现自定义微件时使用。在微件准备好渲染后执行。

removeHandles(groupKey)inherited 起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

groupKey *

optional

要移除的组键或组键的数组或集合。

示例

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

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

render(){Object}inherited

此方法主要由开发人员在实现自定义微件时使用。它必须由子类实现以进行渲染。

类型	描述
Object	渲染的虚拟节点。

renderNow()inherited

立即将微件渲染到 DOM。

scheduleRender()inherited

此方法主要由开发人员在实现自定义微件时使用。计划微件渲染。此方法对于影响 UI 的更改非常有用。

when(callback, errback){Promise}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

一旦创建了类的实例，就可以使用when() 。此方法接受两个输入参数：callback 函数和 errback 函数。callback 在类的实例加载时执行。errback 在类的实例无法加载时执行。

参数

callback Function

optional

当 promise 解决时调用的函数。

errback Function

optional

当 promise 失败时执行的函数。

类型	描述
Promise	为 `callback` 结果返回一个新的 promise。

示例

// 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
});

事件概述

名称	类型	描述	类
	{position: Object}	在调用 locate() 方法并成功后触发。更多详情	Locate
	{error: Error}	在调用 locate() 方法并失败后触发。更多详情	Locate

事件详细说明

locate

在调用 locate() 方法并成功后触发。

属性

position Object

从 Geolocation API 返回的地理位置。

另请参阅

locate()

locate-error

在调用 locate() 方法并失败后触发。

属性

error Error

定位时出现的错误对象。

另请参阅

locate()

GeoScene Maps SDK for JavaScript参考手册

构造函数

属性概述

属性详细信息

方法概述

方法详细说明

事件概述

事件详细说明