DistanceMeasurement2D

DistanceMeasurement2D 小部件计算并显示 MapView 中两个或多个点之间的距离。该微件将计算地理坐标系和网络墨卡托的大地距离。对于投影坐标系（非 web 墨卡托），将对不超过 geodesicDistanceThreshold 定义的阈值距离的距离进行平面计算。等于或超出阈值的距离将通过大地测量计算。默认情况下，阈值设置为 100 公里。

Undo / Redo

Gesture	Action
Z	逐步撤消堆栈中记录的操作。
R	增量重做堆栈中记录的操作。

此微件旨在与 2D MapViews 一起使用。对于使用 3D 场景视图的测量，请使用 DirectLineMeasurement3D。

另请参阅：

示例：

// To add the DistanceMeasurement2D widget to the map
let measurementWidget = new DistanceMeasurement2D({
  view: view
});
view.ui.add(measurementWidget, "top-right");

构造函数

new DistanceMeasurement2D(properties)

参数：

properties Object

可选

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

示例：

// To add the DistanceMeasurement2D widget to the map
let measurementWidget = new DistanceMeasurement2D({
  view: view
});
view.ui.add(measurementWidget, "top-right");

属性概览

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

显示继承的属性

隐藏继承的属性

类型	描述	类
String\|HTMLElement	更多信息表示包含小部件的 DOM 元素的 ID 或节点。	更多信息	微件
String	更多信息类的名称。	更多信息	Accessor
String	更多信息微件的默认 CSS 图标类。	更多信息	DistanceMeasurement2D
String	更多信息创建微件时分配给微件的唯一 ID。	更多信息	微件
String	更多信息微件的默认标签。	更多信息	DistanceMeasurement2D
SystemOrLengthUnit	更多信息用于显示距离值的单位系统（英制、公制）或特定单位。	更多信息	DistanceMeasurement2D
SystemOrLengthUnit []	更多信息用于显示距离值的可用单位和单位系统（英制、公制）列表。	更多信息	DistanceMeasurement2D
MapView	更多信息对 MapView 的引用。	更多信息	DistanceMeasurement2D
DistanceMeasurement2DViewModel	更多信息此微件的视图模型。	更多信息	DistanceMeasurement2D
Boolean	更多信息指示微件是否可见。	更多信息	微件

属性详情

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.folder.className。

iconClass String

微件的默认 CSS 图标类。

id String inherited

创建微件时分配给微件的唯一 ID。如果开发人员未设置，则默认为容器 ID，如果不存在，则会自动生成。

label String

微件的默认标签。

unit SystemOrLengthUnit

用于显示距离值的单位系统（英制、公制）或特定单位。可能的值在 unitOptions 中列出。

示例：

// To create the DistanceMeasurement2D widget that displays distance in yards
let measurementWidget = new DistanceMeasurement2D({
  view: view,
  unit: "yards"
});

// To display the current measurement unit
console.log('Current unit: ', measurementWidget.unit);

unitOptions SystemOrLengthUnit []

用于显示距离值的可用单位和单位系统（英制、公制）列表。默认情况下，包括以下单位：metric, imperial, inches, feet, us-feet, yards, miles, nautical-miles, meters, kilometers.可能的 unit 值只能是此列表的子集。

示例：

// To display the available units to the console
let measurementWidget = new DistanceMeasurement2D({
  view: view
});
console.log('All units: ', measurementWidget.unitOptions.join(", "));

view MapView

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

示例：

// Typical usage
let measurementWidget = new DistanceMeasurement2D({
  view: view
});
view.ui.add(measurementWidget, "top-right");

viewModel DistanceMeasurement2DViewModelautocast

此微件的视图模型。这是一个包含控制此小部件行为的所有逻辑（属性和方法）的类。请参阅 DistanceMeasurement2DViewModel 类以访问小部件上的所有属性和方法。

示例：

// Use the ViewModel to access and set advanced settings
let measurementWidget = new DistanceMeasurement2D({
  viewModel: {
    view: view,
    unit: "feet"
  }
});
view.ui.add(measurementWidget, "top-right");

visible Boolean inherited

指示微件是否可见。

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

默认值:true

示例：

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

方法概览

显示继承的方法

隐藏继承的方法

返回类型	描述	类
String	更多信息用于构建微件 `class` 属性值的实用方法。	更多信息	Widget
	更多信息注销微件实例。	更多信息	Widget
Boolean	更多信息在实例上发出事件。	更多信息	Widget
Boolean	更多信息指示实例上是否存在与提供的事件名称匹配的事件侦听器。	更多信息	Widget
Boolean	更多信息 `isFulfilled()` 可用于验证创建类的实例是否已完成（已解决或已拒绝）。	更多信息	Widget
Boolean	更多信息 `isRejected()` 可用于验证创建类的实例是否被拒绝。	更多信息	Widget
Boolean	更多信息 `isResolved()` 可用于验证创建类的实例是否已解决。	更多信息	Widget
Object	更多信息在实例上注册事件处理程序。	更多信息	Widget
	更多信息微件拆卸助手。	更多信息	Widget
	更多信息此方法主要由开发人员在实现自定义微件时使用。	更多信息	Widget
Object	更多信息此方法主要由开发人员在实现自定义微件时使用。	更多信息	Widget
	更多信息立即将微件呈现给 DOM。	更多信息	Widget
	更多信息此方法主要由开发人员在实现自定义微件时使用。	更多信息	Widget
Promise	更多信息 `when()` 一旦创建了类的实例，就可以利用它。	更多信息	Widget

方法详情

classes(classNames){String}inherited

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

参数：

classNames String|String []|Object

repeatable

类名称。

类型	说明
String	计算出来的类名。

另请参阅：

指南 - 微件开发（rendering）

示例：

// .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

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

参数：

type String

事件的名称。

event Object

可选

事件有效负载。

类型	说明
Boolean	`true` if a listener was notified

hasEventListener(type){Boolean}inherited

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

参数：

type String

事件的名称。

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

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

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

类型	说明
Boolean	指示创建类的实例是否已完成（已解决或已拒绝）。

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

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

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

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

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

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

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(handles)inherited

微件拆卸助手。当微件被销毁时，添加到它的任何句柄都将被自动删除。

参数：

handles WatchHandle|WatchHandle []

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

postInitialize()inherited

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

render(){Object}inherited

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

类型	说明
Object	渲染的虚拟节点。

renderNow()inherited

立即将微件呈现给 DOM。

scheduleRender()inherited

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

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

when() 一旦创建了类的实例，就可以利用它。这个方法有两个输入参数：一个 callback 函数和一个 errback 函数。callback 在类的实例加载时执行。如果类的实例无法加载，则执行 errback。

参数：

callback Function

可选

当 promise 解决时调用的函数。

errback Function

可选

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