Symbol3D 是所有 3D 符号的基类。它用于渲染 FeatureLayer 中的 2D Point、Polyline 和 Polygon 要素,以及 SceneLayer 中的 3D 网格要素。所有 3D 符号均须在 SceneView 实例中使用;在 MapViews 中不支持 3D 渲染。
有五种类型的 3D 符号。其中四个对应于不同的要素几何类型。第五个为 LabelSymbol3D,可应用于任何几何类型。请参阅下表,以了解每种几何类型支持哪些符号类型。
几何类型 | 有效的符号类型 |
---|---|
Point | PointSymbol3D、LabelSymbol3D |
Polyline | LineSymbol3D、LabelSymbol3D |
Polygon | PolygonSymbol3D、LabelSymbol3D |
Mesh | MeshSymbol3D、LabelSymbol3D |
所有 3D 符号都有一个 symbolLayers 属性,该属性是定义符号外观的 Symbol3DLayers 数组。所有符号必须至少具有一个添加到 symbolLayers 属性的符号图层。Symbol3D 对象是一个容器,其中包含多个符号图层,这些图层可定义符号的外观。一个图层可以是轮廓,另一图层可能是填充内容,等等。符号图层与符号之间的关系类似于业务图层与地图的关系。根据要素的符号类型和几何,可以使用各种类型的符号图层。请参阅 Symbol3DLayer 以了解有关符号图层的详细信息。
属性概述
名称 | 类型 | 描述 | 类 |
---|---|---|---|
String | 类的名称。 更多详情 | Accessor | |
StyleOrigin | 最初引用符号的样式的来源。 更多详情 | Symbol3D | |
Collection<Symbol3DLayer> | Symbol3DLayer 对象的集合,用于可视化图形或要素。 更多详情 | Symbol3D | |
String | 符号类型。 更多详情 | Symbol3D |
属性详细信息
-
起始版本:GeoScene Maps SDK for JavaScript 4.7
-
类的名称。声明的类名称格式化为
geoscene.folder.className
。
-
styleOrigin StyleOrigin
-
最初引用符号的样式的来源。对样式来源的引用可以通过 styleName 或 styleUrl (但不是两者) 来完成。此信息是 WebScene 持久化模型的一部分,并可用于了解符号最初的来源。它不影响符号的实际外观或渲染。
-
symbolLayers Collection<Symbol3DLayer>autocast
-
Symbol3DLayer 对象的集合,用于可视化图形或要素。单个符号图层可以自动转换为对象并使用
type
属性指定。
-
type Stringreadonly
-
符号类型。
可能值:"point-3d"|"line-3d"|"polygon-3d"|"mesh-3d"|"label-3d"
方法概述
名称 | 返回值类值 | 描述 | 类 |
---|---|---|---|
添加一个或多个与对象的生命周期相关联的句柄。 更多详情 | Accessor | ||
* | 创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。 更多详情 | Symbol | |
Boolean | 如果存在指定的句柄组,则返回 true。 更多详情 | Accessor | |
移除对象拥有的句柄组。 更多详情 | Accessor | ||
Object | 将此类的实例转换为 GeoScene Portal JSON 表示。 更多详情 | Symbol |
方法详细说明
-
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() 进行删除。如果未提供键,则句柄将被添加到默认组。
-
fromJSON(json){*}static
-
创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入
json
参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例,请参阅指南中的使用 fromJSON() 主题。参数json ObjectGeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例,请参阅 GeoScene REST API 文档。
返回类型 描述 * 返回该类的新实例。
-
起始版本: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");
-
将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息,请参阅使用 fromJSON() 指南主题。
返回类型 描述 Object 此类实例的 GeoScene Portal JSON 表示。