BookmarksViewModel

属性概述

属性详细信息

abilities Abilities

起始版本：GeoScene Maps SDK for JavaScript 4.22

定义微件的功能。此属性可用于启用或禁用 Bookmarks 微件的时间功能。

示例

const bookmarksVM = new BookmarksViewModel({
  view: view,
  abilities: {
     time: false // disables all time ability in the Bookmarks widget
  }
});

activeBookmark Bookmarkreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.9

要导航到的书签。

bookmarks Collection<Bookmark>

Bookmark 集合。

declaredClass Stringreadonly inherited

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

defaultCreateOptions BookmarkOptions

起始版本：GeoScene Maps SDK for JavaScript 4.18

指定如何创建新书签。可用于在创建书签时启用或禁用获取屏幕截图或根据当前视图捕获书签的视点。有关选项的完整列表，请参阅 BookmarkOptions。

defaultEditOptions BookmarkOptions

起始版本：GeoScene Maps SDK for JavaScript 4.18

指定如何编辑书签。可用于在编辑书签时，启用或禁用获取屏幕截图或根据当前视图捕获书签的视点。有关选项的完整列表，请参阅 BookmarkOptions。

goToOverride GoToOverride

此函数提供了覆盖 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

视图模型的状态。

可能值："loading"|"ready"

默认值：ready

view MapView|SceneView

微件将从中操作的视图。

方法概述

方法详细说明

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

createBookmark(options){Promise<Bookmark>}

起始版本：GeoScene Maps SDK for JavaScript 4.13

除非另有指定，否则从 defaultCreateOptions 创建新书签。

参数

options BookmarkOptions optional 指定如何创建新书签。可用于启用/禁用在添加新书签时获取屏幕截图或捕获范围。

返回

类型	描述
Promise<Bookmark>	解析后，返回新创建的书签。

示例

// Creates new bookmark from current view extent
viewModel.createBookmark().then(function(bookmark){
   // Give the bookmark a name
   bookmark.name = "New Bookmark";
   // Add to bookmarks list
   viewModel.bookmarks.add(bookmark);
});

editBookmark(bookmark, options){Promise<Bookmark>}

起始版本：GeoScene Maps SDK for JavaScript 4.17

编辑给定的书签。

参数

bookmark Bookmark 要编辑的书签。

options BookmarkOptions optional 指定如何编辑书签。可用于启用/禁用在编辑书签时获取屏幕截图或捕获范围。如果未指定，则使用 defaultEditOptions。

返回

类型	描述
Promise<Bookmark>	解析后，返回已编辑的书签。

示例

const options = {
  takeScreenshot: false,
  captureViewpoint: true
};

// update the given bookmark's viewpoint without taking a new screenshot
viewModel.editBookmark(bookmark, options).then(function(editedBookmark){
   // the edited bookmark's viewpoint should now match the current view
   console.log(editedBookmark.viewpoint);
   console.log(view.viewpoint);
})

goTo(bookmark){Promise}

缩放至特定书签。

参数

bookmark Bookmark 要缩放到的书签。

返回

类型	描述
Promise	在动画至指定书签完成后解析。

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

类型定义

Abilities Object

指定 Bookmarks 微件的功能。

属性

time Boolean optional 指示是否在 Bookmarks 微件中启用时间功能。默认为 true。当为 false 时，书签的 timeExtent 将不可见或不可编辑。任何新创建的书签都不会捕获时间范围。

BookmarkOptions Object

指定如何创建或修改书签。

属性

takeScreenshot Boolean optional 指示在创建新书签时是否获取屏幕截图。屏幕截图将设置为新创建的书签中的缩略图。默认为 true。

captureViewpoint Boolean optional 自 4.17 起 指示当前视图的视点是否将成为新创建或修改的书签的 viewpoint。默认为 true。

captureRotation Boolean optional 自 4.17 起 指示当前视图的旋转是否将保存在新创建或修改的书签的 viewpoint 中。默认为 true。

captureScale Boolean optional 自 4.17 起 指示当前视图的比例是否将保存在新创建或修改的书签的 viewpoint 中。默认为 true。

captureTimeExtent Boolean optional 自 4.22 起 指示当前视图的时间范围是否将保存在新创建或修改的书签的 timeExtent 中。默认为 true。

screenshotSettings Object optional 一个对象，它指定将用于创建书签缩略图的屏幕截图的设置。 规范 width Number optional 屏幕截图的宽度 (以像素为单位)。默认为 128px。 height Number optional 屏幕截图的高度 (以像素为单位)。默认为 128px。 area Object optional 用于获取视图的子区域的屏幕截图。默认为整个视图。 规范 x Number optional 屏幕截图区域的 x 值。 y Number optional 屏幕截图区域的 y 值。 width Number optional 屏幕截图区域的宽度。 height Number optional 屏幕截图区域的高度。 layers Layer[] optional 要包含在屏幕截图中的可选图层列表。