Expand

Expand 微件充当用于打开微件的可单击按钮。

如果将 Slider、HistogramRangeSlider 或 TimeSlider 作为内容添加到 Expand 微件中，则微件的容器或父容器必须在 CSS 中具有一个 width 集才能在 Expand 微件中呈现。

如果在滑块的容器上设置宽度，请将 slider.container 设置为展开的内容，而不是滑块本身。

expand.content = slider.container

另请参阅

示例

// LayerList
layerList = new LayerList({
  container: document.createElement("div"),
  view: view
});
layerListExpand = new Expand({
  expandIconClass: "geoscene-icon-layer-list",  // see https://doc.geoscene.cn/javascript/4.25/guide/geoscene-icon-font/
  // expandTooltip: "Expand LayerList", // optional, defaults to "展开" for English locale
  view: view,
  content: layerList
});
view.ui.add(layerListExpand, "top-right");

构造函数

new Expand(properties)

参数

properties Object

optional

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

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。

显示继承属性

隐藏继承属性

类型	描述	类
Boolean	在视图的视点更新时自动折叠展开微件实例。更多详情	Expand
Boolean\|Function	如果为 true，则当键盘焦点位于其内容范围内时，按下 Esc 键后，Expand 微件将关闭。更多详情	Expand
String	用于设置 Expand 按钮样式的图标字体。更多详情	Expand
String	要显示的工具提示，用于指示可以折叠 Expand 微件。更多详情	Expand
String\|HTMLElement	包含微件的 DOM 元素的 ID 或节点。更多详情	Widget
Node\|String\|Widget	要在展开的 Expand 微件中显示的内容。更多详情	Expand
String	类的名称。更多详情	Accessor
Boolean	指示微件当前是否已展开。更多详情	Expand
String	用于设置 Expand 按钮样式的图标字体。更多详情	Expand
String	要显示的工具提示，用于指示可以展开 Expand 微件。更多详情	Expand
String	此值将两个或多个 Expand 微件实例相互关联，从而允许在展开同一组中的另一实例时自动折叠一个实例。更多详情	Expand
Number	显示在微件角落处的数字，用于指示未解决的问题或未读通知的数量。更多详情	Expand
String	创建微件时分配给微件的唯一 ID。更多详情	Widget
String	微件的默认的标注。更多详情	Expand
String	微件的显示模式。更多详情	Expand
MapView\|SceneView	对 MapView 或 SceneView 的引用。更多详情	Expand
ExpandViewModel	此微件的视图模型。更多详情	Expand
Boolean	指示微件是否可见。更多详情	Widget

属性详细信息

autoCollapse Boolean

在视图的视点更新时自动折叠展开微件实例。

默认值：false

closeOnEsc Boolean|Function

如果为 true，则当键盘焦点位于其内容范围内时，按下 Esc 键后，Expand 微件将关闭。此属性还可设置为返回布尔值的函数，从而允许对何时可从 esc 键关闭 Expand 微件进行更多自定义。

默认值：true

示例

let expand = new Expand({
   view: view,
   content: searchWidget,
   // widget will not be able to be closed from the ESC key
   closeOnEsc: false
});

let expand = new Expand({
   view: view,
   content: searchWidget,
   // widget will close on ESC when the search widget has no active menu
   closeOnEsc: function() {
     return searchWidget.activeMenu === "none"
   }
});

collapseIconClass String 起始版本：GeoScene Maps SDK for JavaScript 4.4

用于设置 Expand 按钮样式的图标字体。

另请参阅

指南 - GeoScene 图标字体

collapseTooltip String

要显示的工具提示，用于指示可以折叠 Expand 微件。

默认值："Collapse" (English locale)

container String|HTMLElement inherited

包含微件的 DOM 元素的 ID 或节点。此属性只能设置一次。以下示例都是使用微件时的有效用例。

示例

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

content Node|String|Widget

要在展开的 Expand 微件中显示的内容。

如果在滑块的容器 (而不是父容器) 上设置宽度，请将 slider.container 设置为展开的内容，而不是滑块本身。

expand.content = slider.container

示例

// A. specify content with a widget
   let searchWidget = new Search({
     view: view
   });

   let expand = new Expand({
     expandIconClass: "geoscene-icon-search",
     view: view,
     content: searchWidget
   });
   view.ui.add(expand, "bottom-left");

// B. specify content with a string (of HTML)
   content: "Hi, I can have <input placeholder='HTML'/>!"

// C. specify content with a DOM node
   let node = domConstruct.create("div", {
     innerHTML: "I'm a real node!"
   });

   let expand = new Expand({
     expandIconClass: "geoscene-icon-right-arrow",
     view: view,
     content: node
   });
   view.ui.add(expand, "top-right");

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

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

expanded Boolean

指示微件当前是否已展开。

默认值：false

expandIconClass String

用于设置 Expand 按钮样式的图标字体。如果有，将自动使用 content 的 iconClass。

另请参阅

指南 - GeoScene 图标字体

expandTooltip String

要显示的工具提示，用于指示可以展开 Expand 微件。

默认值："展开" (English locale)

group String 起始版本：GeoScene Maps SDK for JavaScript 4.6

此值将两个或多个 Expand 微件实例相互关联，从而允许在展开同一组中的另一实例时自动折叠一个实例。要使自动折叠生效，组的所有实例都必须包含在 view.ui 中。

例如，如果将多个 Expand 实例放置在视图 ui 的左上角，则可以将它们分配给名为 top-left 的组。如果展开了一个 Expand 实例，并且用户单击 top-left 组中的其他实例，则第一个实例将折叠，从而使第二个实例的内容完全可见。

示例

let expand1 = new Expand({
  view: view,
  content: document.getElementById("bg-gallery"),
  expandIconClass: "geoscene-icon-basemap",
  group: "bottom-right"
});
let expand2 = new Expand({
  view: view,
  content: document.getElementById("legend"),
  expandIconClass: "geoscene-icon-key",
  group: "bottom-right"
});

view.ui.add([expand1, expand2], "bottom-right");

iconNumber Number

显示在微件角落处的数字，用于指示未解决的问题或未读通知的数量。

id String inherited

创建微件时分配给微件的唯一 ID。如果不是由开发人员设置的，它将默认为容器 Id，或者如果没有容器 ID，则将自动生成。

label String

微件的默认的标注。

mode String 起始版本：GeoScene Maps SDK for JavaScript 4.7

微件的显示模式。下面列出了这些模式。

mode	description
auto	这是默认模式。它可以响应浏览器大小的更改，并将根据是在桌面还是移动应用程序中查看微件的情况进行更新。
floating	如果您希望将微件始终显示为浮动，而无论浏览器大小如何，请使用此模式。
drawer	如果您希望始终在面板中显示微件，而无论浏览器大小如何，请使用此模式。

可能值："auto"|"floating"|"drawer"

默认值："auto"

view MapView|SceneView

对 MapView 或 SceneView 的引用。设置此选项可将微件链接到特定视图。

viewModel ExpandViewModelautocast

此微件的视图模型。此类包含控制此微件行为的所有逻辑。请参阅 ExpandViewModel 类来访问微件上的所有属性和方法。

visible Boolean inherited

指示微件是否可见。

如果为 false，微件将不再呈现在 web 文档中。这可能会影响文档中其他元素或微件的布局。例如，如果此微件是与视图 UI 右上角关联的三个微件中的第一个，则当此微件不可见时，其他微件将重新定位。有关更多信息，请参阅 CSS display 值 "none"。

默认值：true

示例

// Hides the widget in the view
widget.visible = false;

方法概述

显示继承的方法

隐藏继承的方法

返回值类值	描述	类
	添加一个或多个与对象的生命周期相关联的句柄。更多详情	Accessor
String	用于为微件的 `class` 属性构建值的实用方法。更多详情	Widget
	折叠微件。更多详情	Expand
	销毁微件实例。更多详情	Widget
Boolean	在实例上触发事件。更多详情	Widget
	展开微件。更多详情	Expand
Boolean	指示实例上是否存在与提供的事件名称相匹配的事件监听器。更多详情	Widget
Boolean	如果存在指定的句柄组，则返回 true。更多详情	Accessor
Boolean	`isFulfilled()` 可用于验证创建类的实例是否已完成 (已解决或已拒绝)。更多详情	Widget
Boolean	`isRejected()` 可用于验证创建类的实例是否被拒绝。更多详情	Widget
Boolean	`isResolved()` 可用于验证创建类的实例是否已解决。更多详情	Widget
Object	在实例上注册事件处理程序。更多详情	Widget
	添加一个或多个与微件的生命周期相关联的句柄。更多详情	Widget
	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
	移除对象拥有的句柄组。更多详情	Accessor
Object	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
	立即将微件渲染到 DOM。更多详情	Widget
	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
	切换微件，如果微件已折叠，则展开它；如果已展开，则折叠它。更多详情	Expand
Promise	一旦创建了类的实例，就可以使用`when()` 。更多详情	Widget

方法详细说明

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

classes(classNames){String}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.7

用于为微件的 class 属性构建值的实用方法。这有助于简化 CSS 类设置。

参数

classNames String|String []|Object

repeatable

类名称。

类型	描述
String	计算的类名。

另请参阅

指南 - 微件开发 (渲染器)

示例

// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}

collapse()

折叠微件。

destroy()inherited

销毁微件实例。

emit(type, event){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.5

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

参数

type String

事件的名称。

event Object

optional

事件有效负载。

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

expand()

展开微件。

hasEventListener(type){Boolean}inherited

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

参数

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

isFulfilled(){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

isFulfilled() 可用于验证创建类的实例是否已完成 (已解决或已拒绝)。如果满足，则返回 true。

类型	描述
Boolean	指示创建类的实例是否已完成 (已解决或已拒绝)。

isRejected(){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

isRejected() 可用于验证创建类的实例是否被拒绝。如果被拒绝，则返回 true。

类型	描述
Boolean	指示创建类的实例是否已被拒绝。

isResolved(){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

isResolved() 可用于验证创建类的实例是否已解决。如果已解决，则返回 true。

类型	描述
Boolean	指示创建类的实例是否已解决。

on(type, listener){Object}inherited

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

参数

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

own(handleOrHandles)inherited 起始版本：GeoScene Maps SDK for JavaScript 4.24

添加一个或多个与微件的生命周期相关联的句柄。当微件被销毁时，将移除句柄。

const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true}
);

this.own(handle); // Handle gets removed when the widget is destroyed.

参数

handleOrHandles WatchHandle|WatchHandle []

微件销毁后，标记为要移除的句柄。

postInitialize()inherited

此方法主要由开发人员在实现自定义微件时使用。在微件准备好渲染后执行。

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

render(){Object}inherited

此方法主要由开发人员在实现自定义微件时使用。它必须由子类实现以进行渲染。

类型	描述
Object	渲染的虚拟节点。

renderNow()inherited

立即将微件渲染到 DOM。

scheduleRender()inherited

此方法主要由开发人员在实现自定义微件时使用。计划微件渲染。此方法对于影响 UI 的更改非常有用。

toggle()

切换微件，如果微件已折叠，则展开它；如果已展开，则折叠它。

when(callback, errback){Promise}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

一旦创建了类的实例，就可以使用when() 。此方法接受两个输入参数：callback 函数和 errback 函数。callback 在类的实例加载时执行。errback 在类的实例无法加载时执行。

参数

callback Function

optional

当 promise 解决时调用的函数。

errback Function

optional

当 promise 失败时执行的函数。

类型	描述
Promise	为 `callback` 结果返回一个新的 promise。

示例

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

GeoScene Maps SDK for JavaScript参考手册

构造函数

属性概述

属性详细信息

方法概述

方法详细说明