• geoscene/support

ActionButton

AMD: require(["geoscene/support/actions/ActionButton"], (ActionButton) => { /* code goes here */ });
ESM: import ActionButton from "@geoscene/core/support/actions/ActionButton";
类: geoscene/support/actions/ActionButton
继承于:ActionButton ActionBase Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.8

一个可自定义的按钮,用于执行 PopupLayerListBasemapLayerList 等微件中使用的特定操作。

构造函数

new ActionButton(properties)
参数
properties Object
optional

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

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
Boolean

将此属性设置为 true 以显示微调器图标。

更多详情
ActionBase
String

这会向 ActionButton 节点添加一个 CSS 类。

更多详情
ActionBase
String

类的名称。

更多详情
Accessor
Boolean

表示此操作是否被禁用。

更多详情
ActionBase
String

分配给此操作的 ID 名称。

更多详情
ActionBase
String

将用于表示操作的图像的 URL。

更多详情
ActionButton
String

操作的标题。

更多详情
ActionBase
String

指定操作的类型。

更多详情
ActionButton
Boolean

指示操作是否可见。

更多详情
ActionBase

属性详细信息

将此属性设置为 true 以显示微调器图标。如果操作执行异步操作,例如查询,需要让最终用户知道某个进程正在后台进行,则应执行此操作。将该属性设置回 false,以便通知用户进程已完成。

默认值:false
className String inherited

这会向 ActionButton 节点添加一个 CSS 类。它可以与其 image 属性结合使用,也可单独使用。可在此属性中使用任何图标字体。GeoScene 图标字体会通过 GeoScene Maps SDK for JavaScript 自动提供给您,以用于样式化自定义操作。要使用这些提供的图标字体之一,您必须在类名前加上 geoscene-。例如,Popup 中的默认 zoom-to 操作使用字体 geoscene-icon-zoom-in-magnifying-glass

declaredClass Stringreadonly inherited

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

表示此操作是否被禁用。

默认值:false

分配给此操作的 ID 名称。这用于在监听 trigger-action 事件时区分动作。

image String

将用于表示操作的图像的 URL。此属性将用作节点的背景图像。它可以与 className 属性结合使用,也可单独使用。如果未指定 imageclassName,则将显示默认图标 默认图标

操作的标题。

对于 popups:当空间有限时,操作将显示在菜单中。文本始终显示在图标旁边,但长文本会被截断。将鼠标悬停在该标题上时,会显示带有此标题的工具提示。

对于 LayerList:第一个操作以图标的形式显示在 layerlist 中。layerlist 具有一个菜单,可以显示所有操作及其标题。

type Stringreadonly

指定操作的类型。

对于 ActionButton,类型总是 "button"

默认值:"button"

指示操作是否可见。

默认值:true

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象的生命周期相关联的句柄。

更多详情
Accessor
ActionButton

创建此对象的深度克隆。

更多详情
ActionButton
Boolean

如果存在指定的句柄组,则返回 true。

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor

方法详细说明

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

clone(){ActionButton}

创建此对象的深度克隆。

返回
类型 描述
ActionButton ActionButton 实例的克隆。
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");

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息