LabelSymbol3D

AMD: require(["geoscene/symbols/LabelSymbol3D"], (LabelSymbol3D) => { /* code goes here */ });
ESM: import LabelSymbol3D from "@geoscene/core/symbols/LabelSymbol3D";
类: geoscene/symbols/LabelSymbol3D
继承于:LabelSymbol3D Symbol3D Symbol Accessor
起始版本:GeoScene API for JavaScript 4.0

LabelSymbol3D 用于在 3D SceneView 中为 FeatureLayer 中的特征渲染标签。2D MapViews 不支持此符号类型。

LabelSymbol3D 必须至少包含一个符号层才能在视图中呈现。以下一种或多种符号图层类型可用于定义 3D 标签符号:

Symbol3DLayer Type Flat/Volumetric Size Units 示例
TextSymbol3DLayer flat points s3d-text

下图描绘了一个带有 LabelSymbol3D 定义的标签的 FeatureLayer

3d-labels

另请参阅:
示例:
let labelClass = new LabelClass({
  labelExpressionInfo: {
    expression: "$feature.COUNTY"  // Text for labels comes from COUNTY field
  },
  symbol: {
    type: "label-3d",  // autocasts as new LabelSymbol3D()
    symbolLayers: [{
      type: "text",  // autocasts as new TextSymbol3DLayer()
      material: { color: [ 49,163,84 ] },
      size: 12  // Defined in points
    }]
  }
});
// Add labels to the feature layer
featureLayer.labelsVisible = true;
featureLayer.labelingInfo = [ labelClass ];

构造函数

new LabelSymbol3D(properties)
参数:
properties Object
可选

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

属性概览

可以设置、检索或收听任何属性。请参阅使用属性主题。
显示继承的属性 隐藏继承的属性
名称 类型 描述
Callout3D更多信息

用于向符号添加标注可视化的设置。

更多信息LabelSymbol3D
String更多信息

类的名称。

更多信息Accessor
Collection<TextSymbol3DLayer>更多信息

用于可视化图形或特征的 Symbol3DLayer 对象的集合。

更多信息LabelSymbol3D
String更多信息

符号类型。

更多信息LabelSymbol3D
Accessor更多信息

将符号沿垂直世界轴移动给定高度。

更多信息LabelSymbol3D

属性详情

callout Callout3D
起始版本:GeoScene API for JavaScript 4.4

用于向符号添加标注可视化的设置。标注从正在符号化的点要素位置绘制到符号的垂直偏移。如果未设置 verticalOffset,则此属性无效。目前仅支持 line 类型的标注。请参阅 LineCallout3D

另请参阅:
示例:
let symbol = {
  type: "label-3d",  // autocasts as new LabelSymbol3D()
  symbolLayers: [...],
  verticalOffset: ...,
  callout: {
    type: "line",  // autocasts as new LineCallout3D()
    size: 1.5,
    color: [150, 150, 150],
    border: {
      color: [50, 50, 50]
    }
  }
};
declaredClass Stringreadonly inherited
起始版本:GeoScene API for JavaScript 4.7

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

Autocasts from Object[]

用于可视化图形或特征的 Symbol3DLayer 对象的集合。单个符号图层可以自动转换为对象并使用 type 属性指定。

type Stringreadonly

符号类型。

对于 LabelSymbol3D,类型始终 为"label-3d”

verticalOffset Accessorautocast
起始版本:GeoScene API for JavaScript 4.4

将符号沿垂直世界轴移动给定高度。高度以点或像素等屏幕空间单位设置。对于带有标注的点,应设置 callout verticalOffset

属性:
screenLength Number
Autocasts from Number|string

以点为单位的垂直符号偏移量。该值可以使用以点或像素(例如 12px)表示大小的字符串进行自动转换。

minWorldLength Number
optional

以世界单位表示的最小垂直符号偏移量。它充当下限以避免垂直偏移变得太小。

在以下动画中,左侧的绿色符号的 minWorldLength = 20,右侧的橙色符号的 minWorldLength 尚未设置:

minWorldLength-on

maxWorldLength Number
optional

以世界单位表示的最大垂直符号偏移量。它充当上限以避免垂直偏移变得太大。

在以下动画中,绿色符号的maxWorldLength = 50,橙色符号没有设置 maxWorldLength

maxWorldLength

另请参阅:
示例:
let symbol = {
  type: "label-3d",  // autocasts as new LabelSymbol3D()
  symbolLayers: [...],
  verticalOffset: {
    screenLength: 40,
    maxWorldLength: 100,
    minWorldLength: 20
  },
  callout: ...
};

方法概览

显示继承的方法 隐藏继承的方法
名称 返回类型 描述
LabelSymbol3D更多信息

创建符号的深拷贝。

更多信息LabelSymbol3D
*更多信息

创建此类的新实例并使用从 ArcGIS 产品生成的 JSON 对象的值对其进行初始化。

更多信息符号
Object更多信息

将此类的实例转换为其 GeoScene 门户 JSON 表示。

更多信息符号

方法详情

clone(){LabelSymbol3D}

创建符号的深拷贝。

返回:
类型 说明
LabelSymbol3D 调用此方法的对象的深拷贝。
示例:
// Creates a deep clone of the graphic's symbol
let symLyr = graphic.symbol.clone();
fromJSON(json){*}static

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

参数:
json Object

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

返回:
类型 说明
* 返回此类的新实例。
toJSON(){Object}inherited

将此类的实例转换为其 GeoScene 门户 JSON 表示。有关更多信息,请参阅使用 fromJSON() 指南主题。

返回:
类型 说明
Object 此类实例的 GeoScene 门户 JSON 表示。

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.