format

属性概述

属性详细信息

conversionInfo ConversionInfo

包含描述如何转换此格式的信息。仅应在创建自定义格式时设置此属性。

默认值：null

coordinateSegments CoordinateSegment[]

坐标段数组。每个段代表格式坐标的一部分。

默认值：null

currentPattern String

用作描述此格式应如何显示的模式字符串。该模式应包含由 Format 的 coordinateSegments 属性指定的所有别名。

默认值：null

示例

// Remove the spaces from an mgrs coordinate
let format = coordinateConversionWidget.formats.find(function(format) {
  return format.name === "mgrs";
});

console.log.(format.currentPattern);
// > Z S X Y

format.currentPattern = "ZSXY"

declaredClass Stringreadonly inherited

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

defaultPattern String

描述此格式应如何显示的默认模式。请参阅 currentPattern。

默认值：null

label String

起始版本：GeoScene Maps SDK for JavaScript 4.24

用于在 UI 中标记此格式的字符串。如果未设置，则默认为 name

name String

坐标的名称。CoordinateConversion 微件不应包含多个具有相同名称的格式。

默认值：null

spatialReference SpatialReference

此格式的 SpatialReference。为格式生成的坐标将从该空间参考中的点派生。

viewModel CoordinateConversionViewModel

使用此格式的 CoordinateConversion 微件的视图模型。

方法概述

方法详细说明

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() 进行删除。如果未提供键，则句柄将被添加到默认组。

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

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

类型定义

ConversionInfo

此对象描述应如何投影和格式化格式以进行显示。用于定义需要自定义转换和/或投影逻辑的自定义格式。

属性

convert Function optional 接受点并返回位置的函数。

reverseConvert Function optional 接受字符串并返回 Point 的函数。

CoordinateSegment

一个坐标段代表一个坐标字符串。

MGRS 坐标 (例如 30UVG898998) 由四个部分描述：

1. 别名 Z，格网区： 30U
2. 别名 S，100,000 平方米标志符： VG
3. 别名 X，东 (x 坐标相对于 10,000 平方米)： 898
4. 别名 Y，北 (y 坐标相对于 10,000 平方米)： 998

属性

alias String 字符串，它为坐标字符串的此部分提供名称。

description String 描述此段角色的字符串。

searchPattern RegExp 应从完整坐标中提取此段的正则表达式。

Position Object

使用位置、点、坐标和字符串来描述一个点。

属性

location Point 点几何，表示转换所描述的位置。

coordinate String 表示位置的字符串。