TextSymbol

let textSymbol = {
  type: "text",  // autocasts as new TextSymbol()
  color: "white",
  haloColor: "black",
  haloSize: "1px",
  text: "You are here",
  xoffset: 3,
  yoffset: 3,
  font: {  // autocasts as new Font()
    size: 12,
    family: "Josefin Slab",
    weight: "bold"
  }
};

属性概览

属性详情

angle Number

文字的角度。0 是水平的，角度顺时针移动。

已知限制

3D SceneViews 当前不支持此属性。

默认值:0

示例：

const textSymbol = {
  type: "text", // autocasts as new TextSymbol()
  angle: 90,
  color: "green",
  font: {
    // autocast as new Font()
    family: "Just Another Hand",
    size: 12
  },
  haloColor: "black",
  haloSize: 1,
  horizontalAlignment: "right",
  verticalAlignment: "bottom"
};

backgroundColor Colorautocast

Autocasts from Object|Number[]|String

标签边界框的背景颜色。仅 MapImageLayer 支持此属性。

另请参阅：

• 示例：MapImageLayer - 标注子层要素

borderLineColor Colorautocast

Autocasts from Object|Number[]|String

标签边界框的边框颜色。仅 MapImageLayer 支持此属性。

另请参阅：

• 示例：MapImageLayer - 标注子层要素

borderLineSize Number

标签边界框的边框大小或宽度。仅 MapImageLayer 支持此属性。

另请参阅：

• 示例：MapImageLayer - 标注子层要素

color Colorautocast inherited

Autocasts from Object|Number[]|String

符号的颜色。这可以使用 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
};

declaredClass Stringreadonly inherited

起始版本：GeoScene API for JavaScript 4.7

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

font Fontautocast

用于设置文本样式的字体。此属性允许开发人员设置字体的系列、装饰、大小、样式和粗细属性。

有关更多信息和已知限制，请参阅标签指南页面。

已知限制

• 可用的 Font.family 属性值取决于您使用的是 2D MapView 还是 3D SceneView。

另请参阅：

• 标签指南

示例：

let textSymbol = {
  type: "text",  // autocasts as new TextSymbol()
  text: "Science of Where",
  font: {  // autocasts as new Font()
    family: "Merriweather",
    size: 12,
    style: "italic",
    weight: "bold"
  }
};

haloColor Colorautocast

Autocasts from Object|number[]|string

文本符号光环的颜色。要在 TextSymbol 中包含光环，您还必须在 haloSize 中设置光环的大小。

已知限制

• 亚像素光晕（即 1.25 像素等小数）在各种浏览器中呈现不一致。

示例：

// CSS color string
symbol.haloColor = "dodgerblue";

// HEX string
symbol.haloColor = "#33cc33";

// array of RGBA values
symbol.haloColor = [51, 204, 51, 0.3];

// object with rgba properties
symbol.haloColor = {
  r: 51,
  g: 51,
  b: 204,
  a: 0.7
};

haloSize Numberautocast

Autocasts from Number|String

文本符号光环的大小（以磅为单位）。该值可以使用以点或像素（例如 12px）表示大小的字符串进行自动转换。要在 TextSymbol 中包含光环，您还必须在 haloColor 中设置光环的颜色。

已知限制

• 亚像素光晕（即 1.25 像素等小数）在各种浏览器中呈现不一致。
• 光环大小不应比文本大小大 1/4。例如，如果您的文本大小为 12，则光环大小不应大于 3。

示例：

// haloSize in points
symbol.haloSize = 1;

// haloSize in pixels
symbol.haloSize = "2px";

// haloSize in points
symbol.haloSize = "1pt";

horizontalAlignment String

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

已知限制

• 此属性仅在 TextSymbol 不用于标记目的时适用。标签的 horizontalAlignment 是从 labelPlacement 值推断出来的。

可能的值:"left"|"right"|"center"

默认值:"center"

kerning Boolean

确定是否调整文本字符串中字符之间的间距。

默认值:true

lineHeight Number

起始版本：GeoScene API for JavaScript 4.15

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

该属性可以被视为默认值 1.0 的乘数（例如，值 2.0 将是默认高度的两倍）。可能值的范围是：0.1 - 4.0.如果指定值 0，则将使用默认值 1.0。

默认值:1.0

示例：

const textSymbol = {
  type: "text", // autocasts as new TextSymbol()
  color: "blue",
  haloColor: "white",
  haloSize: 1,
  lineHeight: 1.5
};

lineWidth Numberautocast

Autocasts from Number|String

起始版本：GeoScene API for JavaScript 4.15

确定是否调整文本字符串中字符之间的间距。该值可以使用以点或像素（例如 72px）表示大小的字符串进行自动转换。

默认值为 192 points。可能值的范围是：32px - 512px.

如果文本超出 lineWidth 值，则如果可能，该行将在超出限制的文本之前的空白处中断，并创建一个新行。

已知限制

• 3D SceneViews 当前不支持此属性。
• 默认值可能会在未来版本中更改。

默认值:192

示例：

const textSymbol = {
  type: "text", // autocasts as new TextSymbol()
  color: "blue",
  haloColor: "white",
  haloSize: 1,
  lineWidth: 200
};

rotated Boolean

确定是否旋转文本字符串中的每个字符。

已知限制

3D SceneViews 当前不支持此属性。

默认值:false

text String

要在视图中显示的文本字符串。长文本字符串将被分成多行。线的长度由 lineWidth 属性控制。要手动创建新行，请使用 \n 转义字符。

已知限制

此属性仅在 TextSymbol 用于定义 Graphic 的符号属性时适用，而不是用于标记目的。

另请参阅：

• lineWidth

示例：

symbol.text = "You are here";

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

type Stringreadonly

对于 TextSymbol，类型始终为 "text”。

verticalAlignment String

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

已知限制

• 此属性仅在 TextSymbol 不用于标记目的时适用。标签的 verticalAlignment 是从 labelPlacement 值推断出来的。

可能的值:"baseline"|"top"|"middle"|"bottom"

默认值:"baseline”

xoffset Numberautocast

Autocasts from Number|String

x 轴上的偏移量（以点为单位）。该值可以使用以点或像素（例如 12px）表示大小的字符串进行自动转换。

已知限制

3D SceneViews 当前不支持此属性。

默认值:0

示例：

// xoffset in points
symbol.xoffset = 3;

// xoffset in pixels
symbol.xoffset = "6px";

// xoffset in points
symbol.xoffset = "3pt";

yoffset Numberautocast

Autocasts from Number|String

y 轴上的偏移量（以点为单位）。该值可以使用以点或像素（例如 12px）表示大小的字符串进行自动转换。

已知限制

3D SceneViews 当前不支持此属性。

默认值:0

示例：

// yoffset in points
symbol.yoffset = 3;

// yoffset in pixels
symbol.yoffset = "6px";

// yoffset in points
symbol.yoffset = "3pt";

方法概览

方法详情

clone(){TextSymbol}

创建符号的深拷贝。

返回：

类型	说明
TextSymbol	调用此方法的对象的深拷贝。

示例：

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