HomeViewModel

let homeWidget = new Home({
  viewModel: {  // autocasts as new HomeViewModel()
    view: view
  }
}, "homediv");  // References the DOM node used to place the widget

属性概述

属性详细信息

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() 方法的能力。

另请参阅

• MapView
• SceneView

示例

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

state Stringreadonly

微件的当前状态。

可能值："disabled"|"ready"|"going-home"

默认值：disabled

view MapView|SceneView

与微件实例关联的视图。

viewpoint Viewpointautocast

返回时，要缩放到的 Viewpoint 或视点。初始值是通过几种不同方式确定的：

• 如果未提供 View，则值为 null。
• 如果 View 已准备好，但 Viewpoint 未定义，则 Viewpoint 的初始值是在 View 准备就绪时确定的。
• 如果 View 已准备好，且 Viewpoint 由用户定义，则初始视点值是用户定义的 Viewpoint。

默认值：null

示例

// Creates a viewpoint centered on the extent of a polygon geometry
let vp = new Viewpoint({
  targetGeometry: geom.extent
});

// Sets the model's viewpoint to the Viewpoint based on a polygon geometry
home.ViewModel.viewpoint = vp;

方法概述

方法详细说明

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

cancelGo()

起始版本：GeoScene Maps SDK for JavaScript 4.9

此函数提供了中断和取消将视图导航回视图初始范围的过程的能力。

emit(type, event){Boolean}

起始版本：GeoScene Maps SDK for JavaScript 4.5

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

参数

type String 事件的名称。

event Object optional 事件有效负载。

返回

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

go()

将视图动画到视图的初始 Viewpoint 或 viewpoint 的值。

hasEventListener(type){Boolean}

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

参数

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

on(type, listener){Object}

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

参数

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

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

事件概述

事件详细说明

go

当调用 go() 方法时触发。

另请参阅

• go()

示例

homeWidget.viewModel.on("go", function(event){
  console.log("updating viewpoint");
});