CompassViewModel

AMD: require(["geoscene/widgets/Compass/CompassViewModel"], (CompassVM) => { /* code goes here */ });
ESM: import CompassVM from "@geoscene/core/widgets/Compass/CompassViewModel";
类: geoscene/widgets/Compass/CompassViewModel
继承于:CompassViewModel Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.0

提供 Compass 微件的逻辑。

指南针指示北方相对于当前视图旋转相机方位的位置。默认情况下,这将添加到 SceneView 中。

另请参阅
示例
let view = new MapView({
  container: "viewDiv",
  map: map
});

let compass = new Compass({
  viewModel: {  // autocasts as new CompassViewModel()
    view: view
  })
}, "compassDiv");

构造函数

new CompassViewModel(properties)
参数
properties Object
optional

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

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
GoToOverride

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

更多详情
CompassViewModel
Object

方向轴 (x, y, z)。

更多详情
CompassViewModel
String

视图模型的状态。

更多详情
CompassViewModel
MapView|SceneView

Compass 使用 (SceneView) 或旋转 (MapView) 获取并指示相机方位的视图。

更多详情
CompassViewModel

属性详细信息

declaredClass Stringreadonly inherited
起始版本:GeoScene Maps SDK for JavaScript 4.7

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

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

方向轴 (x, y, z)。

默认值:{ x: 0, y: 0, z: 0 }
state Stringreadonly

视图模型的状态。

可能值"compass"|"rotation"|"disabled"

默认值:disabled

Compass 使用 (SceneView) 或旋转 (MapView) 获取并指示相机方位的视图。

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象的生命周期相关联的句柄。

更多详情
Accessor
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor

如果在 MapView 中使用,请将视图的旋转设置为 0

更多详情
CompassViewModel

方法详细说明

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

如果在 MapView 中使用,请将视图的旋转设置为 0。如果在 SceneView 中使用,请将相机的 heading 设置为 0

每次单击 Compass 时都会执行此方法。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息