Widget

Widget

微件的基类。每个微件的表示形式都与其属性、方法和数据分开。

核心逻辑和表示的分离使得每个微件在使用其他框架和库（如 Bootstrap、React 和 JQuery）时都具有高度可定制性。

每个微件的属性和方法都在其属性中处理，该 viewModel 属性是基于 Accessor-基本的类。由于每个视图模型类都扩展了 Accessor，因此可以使用使用属性主题中概述的方法访问微件上的所有属性。

此设计允许开发人员创建新的微件，并使用使用第三方框架重新调整现有微件的用途。微件的表示形式和核心逻辑的分离也意味着开发人员可以使用该逻辑，而无需渲染其UI组件。有关创建自定义微件的更多信息，请参阅微件开发指南主题。

有关获得对微件样式的完全控制的信息，请参阅样式主题。

示例:

属性列表

可以设置、检索或监听的属性。参见使用属性。

展示继承属性

隐藏继承属性

类型	描述	类
String\|HTMLElement	更多信息包含微件的DOM元素的ID或者节点	更多信息	Widget
String	更多信息类名。	更多信息	Accessor
String	更多信息创建微件时分配给微件的唯一 ID。	更多信息	Widget
String	更多信息微件的标签。	更多信息	Widget
Boolean	更多信息是否显示微件。	更多信息	Widget

属性详细说明

container String|HTMLElement

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

示例代码:

// 在运行时创建HTML div元素，并将其设置为小部件的容器
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

// 创建 HTML div 元素 并且设置为widget的容器

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

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML 标签
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// 在添加到视图的UI时指定widget
const basemapGallery = new BasemapGallery({
  view: view
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

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

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

id String

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

label String 起始版本: GeoScene API for JavaScript 4.22

微件的标签。

每当小部件由另一个微件控制时（例如 Expand)，此属性都很有用。

visible Boolean

是否显示微件。

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

默认值:true

示例代码:

// 在view中隐藏widget
widget.visible = false;

方法列表

返回值类型	描述	类
String	更多信息用于为微件的`class`属性构建值的实用方法。	更多信息	Widget
	更多信息销毁微件实例。	更多信息	Widget
Boolean	更多信息在实例上触发事件。	更多信息	Widget
Boolean	更多信息指示实例上是否存在与提供的事件名称匹配的事件侦听器。	更多信息	Widget
Boolean	更多信息 `isFulfilled()` 可用于验证创建类的实例是否已完成(无论成功或失败)。	更多信息	Widget
Boolean	更多信息 `isRejected()` 可用于验证创建类的实例是否失败。	更多信息	Widget
Boolean	更多信息 `isResolved()` 可用于验证创建类的实例是否成功。	更多信息	Widget
Object	更多信息在实例上注册事件处理程序。	更多信息	Widget
	更多信息微件拆卸助手。	更多信息	Widget
	更多信息这种方法主要由开发人员在实现自定义微件时使用。	更多信息	Widget
Object	更多信息这种方法主要由开发人员在实现自定义微件时使用。	更多信息	Widget
	更多信息立即将微件渲染到 DOM。	更多信息	Widget
	更多信息这种方法主要由开发人员在实现自定义微件时使用。	更多信息	Widget
Promise	更多信息 `when()` 创建类的实例后，会被执行一次。	更多信息	Widget

方法详细说明

classes(classNames){String} 起始版本: GeoScene API for JavaScript 4.22

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

参数:

classNames String|String []|Object

repeatable

class 类名称

返回值:

类型	描述
String	计算出来的类名。

示例:

指南 - 微件开发 (rendering)

示例代码:

// .tsx语法显示在渲染widget时如何设置CSS classs .

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

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

destroy()

销毁微件实例。

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

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

参数:

type String

事件名称

event Object

optional

事件负载。

返回值:

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

hasEventListener(type){Boolean}

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

参数:

type String

事件名称

返回值:

类型	描述
Boolean	如果类支持输入事件，则返回 true。

isFulfilled(){Boolean} 起始版本: GeoScene API for JavaScript 4.22

isFulfilled() 可用于验证创建类的实例是否已完成(无论成功或失败)。如果已完成，将会返回true。

返回值:

类型	描述
Boolean	指示创建类的实例是否已完成（无论成功或失败）。

isRejected(){Boolean} 起始版本: GeoScene API for JavaScript 4.22

isRejected() 可用于验证创建类的实例是否失败。如果失败, 将会返回 true 。

返回值:

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

isResolved(){Boolean} 起始版本: GeoScene API for JavaScript 4.22

isResolved() 可用于验证创建类的实例是否成功。如果成功, 将会返回 true 。

返回值:

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

on(type, listener){Object}

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

参数:

type String|String []

要监听的 event 或者事件数组。

listener Function

事件触发时要调用的函数。

返回值:

类型描述

Object

返回一个remove() 方法的事件处理程序，该方法用以停止侦听事件。

属性	类型	描述
remove	Function	当被调用时，从事件中移除监听器。

示例代码:

view.on("click", function(event){
  // event是事件触发后返回的事件句柄。
  console.log(event.mapPoint);
});

own(handles)

微件拆卸助手。当微件销毁时，添加到它的任何句柄都将被自动删除。

参数:

handles WatchHandle|WatchHandle []

微件销毁后标记为删除的句柄。

postInitialize()

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

render(){Object}

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

返回值:

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

renderNow()

立即将微件渲染到 DOM。

scheduleRender()

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

when(callback, errback){Promise} 起始版本: GeoScene API for JavaScript 4.22

when() 创建类的实例后，会被执行一次。该方法接受两个参数： callback 函数和 errback 函数。 callback 在类的实例加载时执行。如果类的实例无法加载，则执行 errback。

参数:

callback Function

optional

当 Promise 成功时，该函数将被调用。

errback Function

optional

当 Promise 失败时，该函数将被调用。

返回值:

类型	描述
Promise	返回回调结果的新 promise，可用于链接其它函数。

示例代码:

// 尽管此示例使用 BasemapGallery widget，但任何作为 Promise 的类实例都可以以相同的方式使用 when()
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // 当 Promise resolved 时，函数将被执行
}, function(error){
  // 当 Promise 通过 rejected 抛错时，这个函数将被执行
});

GeoScene API for JavaScript参考手册

属性列表

属性详细说明

方法列表

方法详细说明