示例代码:
let homeWidget = new Home({
viewModel: { // 转换成 new HomeViewModel()
view: view
}
}, "homediv"); // References the DOM node used to place the widget
构造函数
属性列表
可以设置、检索或监听的属性。参见 使用属性。
属性 | 类型 | 描述 | 类 | |
---|---|---|---|---|
String | 更多信息 类名。 | 更多信息 | Accessor | |
GoToOverride | 更多信息 此功能提供了覆盖 MapView goTo() or SceneView goTo() 方法 | 更多信息 | HomeViewModel | |
String | 更多信息 微件的当前状态。 | 更多信息 | HomeViewModel | |
MapView|SceneView | 更多信息 与微件实例关联的视图。 | 更多信息 | HomeViewModel | |
Viewpoint | 更多信息 返回时要缩放到的 Viewpoint 或视点。 | 更多信息 | HomeViewModel |
属性详细说明
-
起始版本: 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 或视点。初始值是通过几种不同的方式确定的:
- 默认值: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 | |
更多信息 | 更多信息 | 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 Objectoptional事件负载。
返回值:类型 描述 Boolean 如果侦听器收到通知,则为 true
-
go()
-
-
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 |