Symbol 是所有符号的基类。符号将点、线、面和网格几何表示为 View 中的矢量图形。符号只能在 GraphicsLayer 或 View.graphics 中的单个图形上直接进行设置。否则，它们将分配给应用于 Layer 的 Renderer。
有多种符号可用于描绘要素。选择符号类型取决于以下因素：
下表指示了应根据视图类型使用哪些符号子类。
| 视图类型 | 符号子类 |
|---|---|
| MapView (2D) | FillSymbol、LineSymbol、MarkerSymbol、TextSymbol、WebStyleSymbol、CIMSymbol |
| SceneView (3D) | Symbol3D、WebStyleSymbol、CIMSymbol |
如果在 MapView 中使用数据，请使用下表作为选择符号类型的指南。
如果在 SceneView 中使用数据，请在选择符号类型时使用下表作为指南。
| 几何类型 | 有效的符号类型 |
|---|---|
| Point | PointSymbol3D、LabelSymbol3D、WebStyleSymbol、CIMSymbol |
| Polyline | LineSymbol3D、LabelSymbol3D |
| Polygon | PolygonSymbol3D、LabelSymbol3D |
| Mesh | MeshSymbol3D、LabelSymbol3D |
虽然上表未明确指出，但 3D SceneViews 支持 2D 符号，而 2D MapViews 中不支持 3D 符号。但是，在 SceneView 中工作时，建议首选 3D 符号类型而不是 2D 符号类型。
属性概述
| 名称 | 类型 | 描述 | 类 |
|---|---|---|---|
| Color | 符号的颜色。 更多详情 | Symbol | |
| String | 类的名称。 更多详情 | Accessor | |
| String | 符号类型。 更多详情 | Symbol |
属性详细信息
-
符号的颜色。这可以通过 rgb(a) 值数组、命名字符串、十六进制字符串或 hsl(a) 字符串、具有
r,g,b和a属性的对象或 Color 对象进行自动转换。- 默认值：black
示例// CSS color string symbol.color = "dodgerblue";// HEX string symbol.color = "#33cc33";// array of RGBA values symbol.color = [51, 204, 51, 0.3];// object with rgba properties symbol.color = { r: 51, g: 51, b: 204, a: 0.7 };
-
起始版本：GeoScene Maps SDK for JavaScript 4.7
-
类的名称。声明的类名称格式化为
geoscene.folder.className。
-
type Stringreadonly
-
符号类型。
可能值："simple-marker"|"picture-marker"|"simple-line"|"simple-fill"|"picture-fill"|"text"|"shield-label-symbol"|"point-3d"|"line-3d"|"polygon-3d"|"web-style"|"mesh-3d"|"label-3d"|"cim"
方法概述
| 名称 | 返回值类值 | 描述 | 类 |
|---|---|---|---|
添加一个或多个与对象的生命周期相关联的句柄。 更多详情 | 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");
-
toJSON(){Object}
-
将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息，请参阅使用 fromJSON() 指南主题。
返回类型 描述 Object 此类实例的 GeoScene Portal JSON 表示。