HomeViewModel

AMD: require(["geoscene/widgets/Home/HomeViewModel"], (HomeVM) => { /* 代码 */ });
ESM: import HomeVM from "@geoscene/core/widgets/Home/HomeViewModel";
类: geoscene/widgets/Home/HomeViewModel
继承于: HomeViewModel Accessor
起始版本: GeoScene API for JavaScript 4.22

Home 微件提供逻辑,该微件将 View 设置为其初始状态 Viewpoint 或之前定义的 viewpoint

示例:
示例代码:
let homeWidget = new Home({
  viewModel: {  // 转换成 new HomeViewModel()
    view: view
  }
}, "homediv");  // References the DOM node used to place the widget

构造函数

new HomeViewModel(properties)
参数:
properties Object
optional

所有可传入构造函数的属性,请参见属性列表

属性列表

可以设置、检索或监听的属性。参见 使用属性
展示继承属性 隐藏继承属性
属性 类型 描述
String更多信息

类名。

更多信息Accessor
GoToOverride更多信息

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

更多信息HomeViewModel
String更多信息

微件的当前状态。

更多信息HomeViewModel
MapView|SceneView更多信息

与微件实例关联的视图。

更多信息HomeViewModel
Viewpoint更多信息

返回时要缩放到的 Viewpoint 或视点。

更多信息HomeViewModel

属性详细说明

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

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

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

微件的当前状态。

可选值:"disabled"|"ready"|"going-home"

默认值:disabled

与微件实例关联的视图。

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;

方法列表

属性 返回值类型 描述
更多信息

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

更多信息HomeViewModel
Boolean更多信息

在实例上触发事件。

更多信息HomeViewModel
更多信息

将视图动画到视图的初始 Viewpointviewpoint 的值。

更多信息HomeViewModel
Boolean更多信息

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

更多信息HomeViewModel
Object更多信息

在实例上注册事件处理程序。

更多信息HomeViewModel

方法详细说明

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

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

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

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

参数:
type String

事件名称

event Object
optional

事件负载。

返回值:
类型 描述
Boolean 如果侦听器收到通知,则为true 
go()

将视图动画到视图的初始 Viewpointviewpoint 的值。

hasEventListener(type){Boolean}

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

参数:
type String

事件名称

返回值:
类型 描述
Boolean 如果类支持输入事件,则返回 true。
on(type, listener){Object}

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

参数:

要监听的event 或者事件数组

listener Function

事件触发时要调用的函数

返回值:
类型 描述
Object 返回一个remove() 方法的事件处理程序,该方法用以停止侦听事件。
属性 类型 描述
remove Function 当被调用时,从事件中移除监听器。
示例代码:
view.on("click", function(event){
  // event是事件触发后返回的事件句柄。
  console.log(event.mapPoint);
});

事件概览

属性 类型 描述
更多信息

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

更多信息 HomeViewModel

事件详情

go

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

示例:
示例代码:
homeWidget.viewModel.on("go", function(event){
  console.log("updating viewpoint");
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.