Font

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

用于显示 2D 文本符号3D 文本符号的字体。此类允许开发人员设置字体 familydecorationsizestyleweight 属性。请注意每个属性的“已知限制”,以了解它们如何根据图层类型以及您是否使用 MapViewSceneView 而有所不同。

另请参阅
示例
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"
  }
};

构造函数

new Font(properties)
参数
properties Object
optional

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

属性概述

所有属性都可以设置、获取和监听。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
String

文本修饰符。

更多详情
Font
String

文本的字体系列。

更多详情
Font
Number

字体大小(以磅为单位)。

更多详情
Font
String

文本样式。

更多详情
Font
String

文本粗细。

更多详情
Font

属性详细信息

declaredClass Stringreadonly inherited
起始版本:GeoScene Maps SDK for JavaScript 4.7

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

decoration String

文本修饰符。

可能值"underline"|"line-through"|"none"

默认值:none
family String

文本的字体系列。可能值取决于图层类型,以及您使用的是 MapView 还是 SceneView。有关详细说明,请参阅标注指南页面,或单击下面的 Read more

3D SceneViews 的字体系列

3D SceneViews 支持的字体系列取决于安装在用户计算机和 Web 浏览器上的字体。如果应用程序使用了未安装的字体,Font 类将实现一个回退机制,该机制将使用默认字体系列值,即 sans-serif。有关如何在 WindowsMac 上安装新字体的说明,请参阅这些参考资料。

本地未安装的字体也可通过在 css 文件中定义 @font-face 并从符号层中的 family 属性引用它来从 url 加载。

2D MapImageLayer 的字体系列

MapView 中的 MapImageLayers 支持的字体系列取决于安装在发布图层的 GeoScene Server 上的字体。如果应用程序使用了未安装的字体,Font 类将实现一个回退机制,该机制将使用默认字体系列值,即 sans-serif

2D FeatureLayer、CSVLayer、StreamLayer 和 TextSymbol 的字体系列

支持的字体系列基于 .pbf 格式的托管字体文件。默认情况下,可用字体大多与 GeoScene 矢量底图使用的字体相同。这些字体可通过 获得。通过设置 geosceneConfig.fontsUrl 属性,可以将 URL 配置为指向您自己的字体资源。如果应用程序使用了未安装的字体,Font 类将实现一个回退机制,该机制将使用默认字体系列值,即 sans-serif。这使用 Arial Unicode MS 字体文件。

默认值:sans-serif
另请参阅
示例
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"
  }
};
自动转换自 Number|String

字体大小(以磅为单位)。此值可以是自动转换的,其字符串以磅或像素表示大小 (例如 12px)。

已知限制

在 3D SceneViews 中,如果设置了 TextSymbol3DLayer.size 属性,它将覆盖此 size 属性。

默认值:9
另请参阅
示例
// size in points
symbol.size = 14;
// size in pixels
symbol.size = "20px";
// size in points
symbol.size = "14pt";
style String

文本样式。指定是否应设置字体样式:正常、斜体或倾斜。

已知限制

oblique 在以下环境中不受支持:2D FeatureLayerCSVLayerStreamLayer 标注。

可能值"normal"|"italic"|"oblique"

默认值:normal
另请参阅
weight String

文本粗细。指定粗体级别。

已知限制

bolderlighter 在以下环境中不受支持:2D FeatureLayerCSVLayerStreamLayer 标注。

可能值"normal"|"bold"|"bolder"|"lighter"

默认值:normal
另请参阅

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象生命周期相关联的句柄

更多详情
Accessor
Font

创建 font 对象的深度克隆。

更多详情
Font
*

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

更多详情
Font
Boolean

如果存在指定的句柄组,则返回 true。

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

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

更多详情
Font

方法详细说明

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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
参数
handleOrHandles WatchHandle|WatchHandle[]

对象销毁后,标记为要移除的句柄。

groupKey *
optional

标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键,则句柄将被添加到默认组。

clone(){Font}

创建 font 对象的深度克隆。

返回
类型 描述
Font 调用此方法的对象的深度克隆。
fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。

参数
json Object

GeoScene 格式实例的 JSON 表示。

返回
类型 描述
* 返回该类的新实例。
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}

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

返回
类型 描述
Object 此类实例的 GeoScene Portal JSON 表示。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。