Locate

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

locate-button

定位微件在不安全的源上不受支持。若要使用它，请将应用程序切换到安全源，如 HTTPS。请注意，localhost被认为是"潜在安全的"，可用于在支持 Window.isSecureContext 目前为Chrome和Firefox）的浏览器中轻松测试。

从版本 4.2 开始，定位按钮不再显示在不安全的 Web 应用中。在 4.1 版本中，这仅适用于Google Chrome。

Known Limitation

T"定位"微件不能与" Track 微件同时工作。一次只能使用其中一个小部件。

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

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

有关获得对widget样式的完全控制的信息，请参阅样式主题。

示例:

示例代码:

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	更多信息包含widget的DOM元素的ID或者节点	更多信息	Widget
String	更多信息类名。	更多信息	Accessor
Object	更多信息用于定位的 HTML5 地理位置位置选项。	更多信息	Locate
Boolean	更多信息指示微件是否应将视图导航到地理位置结果的位置和比例。	更多信息	Locate
GoToOverride	更多信息此功能提供了覆盖 MapView goTo() or SceneView goTo() 方法	更多信息	Locate
Graphic	更多信息用于在地图上显示用户位置的图形。	更多信息	Locate
String	更多信息 widget默认样式图标类	更多信息	Locate
String	更多信息创建部件时分配给部件的唯一ID。	更多信息	Widget
String	更多信息 widget 默认的label	更多信息	Locate
Boolean	更多信息指示是否显示 locate() 方法中的结果图形的 Popup 。	更多信息	Locate
Number	更多信息指示在从 track 事件返回位置后导航到地理位置结果的位置时要在视图上设置的比例。	更多信息	Locate
Boolean	更多信息指示微件是否将自动旋转 rotate to user's direction.	更多信息	Locate
MapView\|SceneView	更多信息对MapView 或者 SceneView 的引用	更多信息	Locate
LocateViewModel	更多信息 widget的视图模型。	更多信息	Locate
Boolean	更多信息是否显示widget	更多信息	Widget

属性详细说明

container String|HTMLElement inherited

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

示例代码:

// 在运行时创建HTML div元素，并将其设置为小部件的容器
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

// 创建 HTML div 元素 并且设置为widget的容器

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

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML 标签
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// 在添加到视图的UI时指定widget
const basemapGallery = new BasemapGallery({
  view: view
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass Stringreadonly inherited 起始版本: GeoScene API for JavaScript 4.22

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

geolocationOptions Object

用于定位的 HTML5 地理位置位置选项。有关详细信息，请参阅 Geolocation API Specification 。

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

goToLocationEnabled Boolean

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

默认值:true

goToOverride GoToOverride 起始版本: GeoScene API for JavaScript 4.22

此功能提供了覆盖 MapView goTo() or SceneView goTo() 方法

示例:

示例代码:

// 以下代码段使用了搜索小部件，但可以应用于任何应用程序
// widgets 都支持  goToOverride 属性
search.goToOverride = function(view, goToParams) {
  goToParams.options.duration = updatedDuration;
  return view.goTo(goToParams.target, goToParams.options);
};

graphic Graphicautocast

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

示例代码:

let locateWidget = new Locate({
  viewModel: { // 转换成 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 API for JavaScript 4.22

widget默认样式图标类

id String inherited

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

label String 起始版本: GeoScene API for JavaScript 4.22

widget 默认的label

popupEnabled Boolean 起始版本: GeoScene API for JavaScript 4.22

Indicates whether to display the Popup of the result graphic from the locate() method.

默认值:true

示例:

Search.popupEnabled

scale Number 起始版本: GeoScene API for JavaScript 4.22

指示从track 事件返回位置后导航到地理定位结果的位置时在视图上设置的比例.如果未明确设置比例值，则视图将导航到默认比例 2500。对于二维视图，该值应在 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 API for JavaScript 4.22

指示小部件是否会自动旋转到用户方向. 设置为 false 以禁用此行为。

默认值:true

view MapView|SceneView

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

viewModel LocateViewModelautocast

widget的视图模型。这是一个包含所有未定义逻辑的类。请参阅 LocateViewModel 类以访问小部件上的所有属性和方法。

visible Boolean inherited

是否显示widget

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

默认值:true

示例代码:

// 在view中隐藏widget
widget.visible = false;

方法列表

展示继承方法

隐藏继承方法

返回值类型	描述	类
	更多信息此函数提供了中断和取消以编程方式获取用户设备位置的过程的能力。	更多信息	Locate
String	更多信息用于为widgets的`class`属性构建值的实用方法	更多信息	Widget
	更多信息销毁widget实例。	更多信息	Widget
Boolean	更多信息在实例上触发事件。	更多信息	Widget
Boolean	更多信息指示实例上是否存在与提供的事件名称匹配的事件侦听器。	更多信息	Widget
Boolean	更多信息 `isFulfilled()` 可用于验证创建类的实例是否已完成(无论成功或失败)。	更多信息	Widget
Boolean	更多信息 `isRejected()` 可用于验证创建类的实例是否失败。	更多信息	Widget
Boolean	更多信息 `isResolved()` 可用于验证创建类的实例是否成功。	更多信息	Widget
Promise<Object>	更多信息 Animates the view to the user's location.	更多信息	Locate
Object	更多信息在实例上注册事件处理程序。	更多信息	Widget
	更多信息 Widget teardown helper.	更多信息	Widget
	更多信息这种方法主要由开发人员在实现自定义widget时使用。	更多信息	Widget
Object	更多信息这种方法主要由开发人员在实现自定义widget时使用。	更多信息	Widget
	更多信息立即将widget渲染到DOM。	更多信息	Widget
	更多信息这种方法主要由开发人员在实现自定义widget时使用。	更多信息	Widget
Promise	更多信息 `when()` 创建类的实例后，会被执行一次。	更多信息	Widget

方法详细说明

cancelLocate() 起始版本: GeoScene API for JavaScript 4.22

This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device.

classes(classNames){String}inherited 起始版本: GeoScene API for JavaScript 4.22

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

undefined

参数:

classNames String|String []|Object

repeatable

class 类名称

返回值:

类型	描述
String	The computed class name.

示例:

Guide - Widget development (rendering)

示例代码:

// .tsx语法显示在渲染widget时如何设置CSS classs .

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

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

destroy()inherited

销毁widget实例。

emit(type, event){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

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

参数:

type String

事件名称

event Object

optional

事件负载。

返回值:

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

hasEventListener(type){Boolean}inherited

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

参数:

type String

事件名称

返回值:

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

isFulfilled(){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

isFulfilled() 可用于验证创建类的实例是否已完成(无论成功或失败)。如果已完成，将会返回true。

返回值:

类型	描述
Boolean	指示创建类的实例是否已完成（无论成功或失败）。

isRejected(){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

isRejected() 可用于验证创建类的实例是否失败。如果失败, 将会返回 true 。

返回值:

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

isResolved(){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

isResolved() 可用于验证创建类的实例是否成功。如果成功, 将会返回 true 。

返回值:

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

locate(){Promise<Object>}

Animates the view to the user's location.

返回值:

类型	描述
Promise<Object>	Resolves to an object with the same specification as the event object defined in the locate event.

示例代码:

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 []

要监听的event 或者事件数组

listener Function

事件触发时要调用的函数

返回值:

类型描述

Object

返回一个remove() 方法的事件处理程序，该方法用以停止侦听事件。

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

示例代码:

view.on("click", function(event){
  // event是事件触发后返回的事件句柄。
  console.log(event.mapPoint);
});

own(handles)inherited

Widget teardown helper. 当widget被销毁时，添加到它的任何句柄都将被自动删除。

参数:

handles WatchHandle|WatchHandle []

widget销毁后标记为删除的句柄。

postInitialize()inherited

这种方法主要由开发人员在实现自定义widget时使用。 在widget准备好后执行。

render(){Object}inherited

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

返回值:

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

renderNow()inherited

立即将widget渲染到DOM。

scheduleRender()inherited

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

when(callback, errback){Promise}inherited 起始版本: GeoScene API for JavaScript 4.22

when() 创建类的实例后，会被执行一次。该方法接受两个参数： callback 函数和 errback 函数。 callback 在类的实例加载时执行。如果类的实例无法加载，则执行 errback。

参数:

callback Function

optional

当 Promise 成功时，该函数将被调用。

errback Function

optional

当 Promise 失败时，该函数将被调用。

返回值:

类型	描述
Promise	返回回调结果的新promise，可用于 chain additional functions.

示例代码:

// 尽管此示例使用 BasemapGallery widget，但任何作为 Promise 的类实例都可以以相同的方式使用 when()
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // 当 Promise resolved 时，函数将被执行
}, function(error){
  // 当 Promise 通过 rejected 抛错时，这个函数将被执行
});

Event Overview

属性	类型	描述	类
	{position: Object}	更多信息在调用 locate() 方法成功后触发。	更多信息	Locate
	{error: Error}	更多信息在调用 locate() 方法后失败后并触发	更多信息	Locate

Event Details

locate

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

Property:

position Object

从地理位置 Geolocation API 返回地址位置。

示例:

locate()

locate-error

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

Property:

error Error

定位时发生的错误对象。

示例:

locate()

GeoScene API for JavaScript参考手册

构造函数

属性列表

属性详细说明

方法列表

方法详细说明

Event Overview

Event Details