TextSymbol3DLayer

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  // points
    }]
  }
});
// Add labels to the feature layer
featureLayer.labelsVisible = true;
featureLayer.labelingInfo = [ labelClass ];

属性概述

属性详细信息

background Accessorautocast

文本的背景。背景可用于定义文本的背景颜色，以通过增加与背景的对比度来提高可读性。设置背景将为文本添加额外的填充并使用圆角显示。

属性

color Color optional 自动转换自 Object|Number[]|String 背景的颜色。

示例

symbolLayer.background = { color: [0, 0, 0, 0.75] };

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

font Font

文本标注的字体。

halo Objectautocast

起始版本：GeoScene Maps SDK for JavaScript 4.4

文本周围的光晕。

属性

color Color optional 默认值：black 自动转换自 Object|Number[]|String 光晕的颜色。这可以通过 rgb(a) 值数组、命名字符串、十六进制字符串或 hsl(a) 字符串、具有 r, g, b 和 a 属性的对象或 Color 对象进行自动转换。

size Number optional 默认值：0 自动转换自 Number|String 光晕的大小，以磅为单位。此值可以是自动转换的，其字符串以磅或像素表示大小 (例如 12px)。

示例

symbolLayer.halo = {
 color: [255, 255, 255, 0.8], // autocasts as Color
 size: 2
}

horizontalAlignment String

起始版本：GeoScene Maps SDK for JavaScript 4.23

调整多行文本的水平对齐方式。

已知限制

• 此属性仅在符号图层不用于标注目的时适用。标注的 horizontalAlignment 是从 labelPlacement 值推断出来的。
• 如果将符号图层添加到具有线标注或垂直偏移的符号，则仅支持 center。

可能值："left"|"right"|"center"

默认值："center"

lineHeight Number

起始版本：GeoScene Maps SDK for JavaScript 4.23

每行文本之间的空间高度。仅适用于多行文本。

该属性可以看作是默认值 1.0 的乘数 (例如，值 2.0 将是默认高度的两倍)。可能值的范围是：0.1 - 4.0。如果指定值 0，则将使用默认值 1.0。

默认值：1.0

material Objectautocast

用于为文本着色的材料。

属性

color Color optional 默认值：white 自动转换自 Object|Number[]|String 文本的颜色。这可以通过 rgb(a) 值数组、命名字符串、十六进制字符串或 hsl(a) 字符串、具有 r, g, b 和 a 属性的对象或 Color 对象进行自动转换。

示例

// CSS color string
symbolLayer.material = {
  color: "dodgerblue"
};

// HEX string
symbolLayer.material = {
  color: "#33cc33";
}

// array of RGBA values
symbolLayer.material = {
  color: [51, 204, 51, 0.3];
}

// object with rgba properties
symbolLayer.material = {
  color: { r: 51, g: 51, b: 204, a: 0.7 }
};

size Numberautocast

自动转换自 Number|String

文本标注的大小 (以磅为单位)）。此值可以是自动转换的，其字符串以磅或像素表示大小 (例如 12px)。设置后，此属性将覆盖 font.size 属性。

默认值：9

示例

// size in points
symbolLayer.size = 14;

// size in pixels
symbolLayer.size = "20px"; // autocasts as number

// size in points
symbolLayer.size = "14pt"; // autocasts as number

text String

要显示的文本。要手动创建新行，请使用 \n 转义字符。

示例

symbolLayer.text = "You are here";

symbolLayer.text = "Wish you were \n here";

type Stringreadonly

符号类型。

对于 TextSymbol3DLayer，类型总是 "text"。

verticalAlignment String

起始版本：GeoScene Maps SDK for JavaScript 4.23

调整文本的垂直对齐方式。

已知限制

• 此属性仅在符号图层不用于标注目的时适用。标注的 verticalAlignment 是从 labelPlacement 值推断出来的。

可能值："baseline"|"top"|"middle"|"bottom"

默认值："baseline"

方法概述

方法详细说明

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

创建符号图层的深度克隆。

返回

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

示例

// Creates a deep clone of the graphic's first symbol layer
const symbolLayer = graphic.symbol.symbolLayers.getItemAt(0).clone();

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 表示。