WebStyleSymbol

// Referencing a web style via styleName
let symbol = {
  type: "web-style",  // autocasts as new WebStyleSymbol()
  styleName: "EsriThematicShapesStyle",
  name: "Standing Diamond"
};

// Referencing a web style via styleUrl
let symbol = {
  type: "web-style",  // autocasts as new WebStyleSymbol()
  styleUrl: "http://www.geosceneonline.cn/geoscene/sharing/rest/content/items/bf27400d167d4c2e8e12c8a46f87afe4/data",
  name: "Centered Sphere"
};

属性概述

属性详细信息

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

name String

Web 样式中符号的名称。Web 样式中的每个符号都由唯一的名称标识。此处只能引用 GeoScene Web 样式符号 (2D) 和 GeoScene Web 样式符号 (3D)。

另请参阅

• 指南 - WebStyleSymbol 参考列表

portal Portalautocast

包含此符号所指的 web 样式的门户。仅当设置 styleName 时才需要。

默认为 config.portalUrl 中的值 (例如 https://www.geosceneonline.cn/geoscene)。

styleName String

已注册的 Web 样式名称。此处只能引用 GeoScene Web 样式符号 (2D) 和 GeoScene Web 样式符号 (3D)。请注意，2D Web 样式符号仅在 2D 中受支持，3D Web 样式符号仅在 3D 中受支持，但 EsriIconsStyle 除外，它可在 2D 和 3D 中使用。

需要设置 portal 属性。不能与 styleUrl 结合使用。

请参阅类描述的例子。

另请参阅

• 指南 - WebStyleSymbol 参考列表

styleUrl String

指向 Web 样式定义的 URL。不能与 styleName 和 portal 结合使用。

请参阅类描述的例子。

type Stringreadonly

对于 WebStyleSymbol，类型总是 "web-style"。

方法概述

方法详细说明

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(){WebStyleSymbol}

创建 symbol 的深度克隆。

返回

类型	描述
WebStyleSymbol	调用此方法的对象的深度克隆。

示例

// Creates a deep clone of the graphic's symbol
let symLyr = graphic.symbol.clone();

fetchCIMSymbol(options){Promise<CIMSymbol>}

起始版本：GeoScene Maps SDK for JavaScript 4.16

返回 WebStyleSymbol 引用的 CIMSymbol 实例。

参数

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<CIMSymbol>	解析后，返回 CIMSymbol 实例。

示例

// Given a SimpleRenderer with a WebStyleSymbol,
// fetch the corresponding CIMSymbol,
// then replace the renderer symbol with the returned CIMSymbol
renderer.symbol.fetchCIMSymbol().then(function (cimSymbol) {
  renderer.symbol = cimSymbol;
});

fetchSymbol(options){Promise<PointSymbol3D>}

下载并返回 WebStyleSymbol 引用的 PointSymbol3D 实例。

参数

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<PointSymbol3D>	解析后，返回 PointSymbol3D 实例。

另请参阅

• 指南 - 使用 3D 符号可视化点

示例

// Given a SimpleRenderer with a WebStyleSymbol, replaces the symbol with its non-referencing version by fetching it
renderer.symbol.fetchSymbol().then(function(actualSymbol) {
  renderer.symbol = actualSymbol;
});

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品toJSON()方法。有关何时以及如何使用该函数的详细信息和示例，请参阅指南中的使用 fromJSON() 主题。

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

类型	描述
*	返回该类的新实例。

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

toJSON(){Object}inherited

将此类的实例转换为其 GeoScene portal JSON表示。有关详细信息，请参阅使用 fromJSON() 指南主题。

返回

类型	描述
Object	此类实例的 GeoScene portal JSON表示。