天气 | 参考手册 | GeoScene API for JavaScript

Weather 微件提供了一个界面，用于在 SceneView 中轻松选择和配置天气。

另阅：

例子：

const widget = new Weather({ view: view });

// Adds the weather widget in
// the top right corner of the view
view.ui.add(widget, "top-right");

构造函数

new Weather(properties)

参数：

properties Object

optional

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

属性概述

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

展示继承属性

隐藏继承属性

类型	总结	类
String\|HTMLElement	更多信息表示包含微件的 DOM 元素的 ID 或节点。	更多信息	Widget
String	更多信息类的名称。	更多信息	Accessor
Number	更多信息指示用于微件标题的标题级别。	更多信息	Weather
String	更多信息微件的默认 CSS 图标类。	更多信息	Weather
String	更多信息创建微件时分配给微件的唯一 ID。	更多信息	Widget
String	更多信息微件的默认标签。	更多信息	Weather
SceneView	更多信息对视图的引用。	更多信息	Weather
WeatherViewModel	更多信息此微件的视图模型。	更多信息	Weather
Boolean	更多信息指示微件是否可见。	更多信息	Widget

属性详述

container String|HTMLElement inherited

表示包含微件的 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.folder.className。

headingLevel Number

表示用于微件标题的标题级别。默认情况下，此消息呈现为 4 级标题（例如 <h4>Time range</h4>）。根据微件在您的应用中的位置，您可能需要调整此标题以获得正确的语义。这对于满足可访问性标准很重要。

默认值:4

另参阅:

标题元素

例如

widget.headingLevel = 4;

iconClass String

微件的默认 CSS 图标类。

id String inherited

创建微件时分配给微件的唯一 ID。如果开发人员未设置，则默认为容器 ID，如果不存在，则会自动生成。

label String

微件的默认标签。

view SceneView

对视图的引用。此微件仅在 SceneView 中受支持。

viewModel WeatherViewModelautocast

此微件的视图模型。这是一个包含控制此微件行为的所有逻辑（属性和方法）的类。请参阅 WeatherViewModel 类以访问微件上的所有属性和方法。

visible Boolean inherited

表示微件是否可见。

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

默认值:true

例如：

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

方法概述

展示继承方法

隐藏继承的方法

返回类型	总结	类
String	更多信息用于构建微件 `class` 属性值的实用方法。	更多信息	Widget
	更多信息销毁微件实例。	更多信息	Widget
Boolean	更多信息在实例上发出事件。	更多信息	Widget
	更多信息当微件出现致命错误时（即	更多信息	Weather
	更多信息当微件出现非致命错误时，我们会显示 UI，但会在底部显示警告。	更多信息	get
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}inherited

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

参数：

classNames String|String []|Object

repeatable

类名

类型	描述
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()inherited

销毁微件实例。

emit(type, event){Boolean}inherited

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

参数

type String

事件的名称。

event Object

optional

事件有效负载。

类型	描述
Boolean	如果通知了侦听器，则为 `true`

get()inner

当微件出现致命错误（即它根本无法工作）时，不会显示天气配置 UI。而是显示错误消息。

get()inner

当微件出现非致命错误时，我们会显示 UI，但会在底部显示警告。

hasEventListener(type){Boolean}inherited

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

参数：

type String

事件的名称。

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

isFulfilled(){Boolean}inherited

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

类型	描述
Boolean	表示创建类的实例是否已完成（已解决或已拒绝）。

isRejected(){Boolean}inherited

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

类别	描述
Boolean	创建类的实例是否已被拒

isResolved(){Boolean}inherited

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

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

on(type, listener){Object}inherited

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

参数：

type String|String []

要侦听的事件或事件数组。

listener Function

事件触发时调用的函数。

类型描述

Object

返回带有 remove() 方法的事件处理程序，应调用该方法以停止侦听事件。

属性	类型	描述
remove	Function	当被调用时，删除事件的侦听器。

例子：

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

own(handles)inherited

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

参数：

handles WatchHandle|WatchHandle []

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

postInitialize()inherited

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

render(){Object}inherited

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

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

renderNow()inherited

立即将微件呈现给 DOM。

scheduleRender()inherited

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

when(callback, errback){Promise}inherited

一旦创建了类的实例，就可以利用 when() 。这个方法有两个输入参数：一个callback 函数和一个 errback 函数。 callback 在类的实例加载时执行。如果类的实例无法加载，则执行 errback 。

参数：

callback Function

optional

当 promise 解决时调用的函数。

errback Function

optional

当 promise 失败时执行的函数。

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

例子：

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

GeoScene API for JavaScript参考手册

天气

构造函数

属性概述

属性详述

方法概述

方法详述