JavaScript ArcGIS symbolUtils.renderPreviewHTML用法及代码示例

基本信息

以下是所在类或对象的基本信息。

AMD: require(["esri/symbols/support/symbolUtils"], (symbolUtils) => { /* code goes here */ });

ESM: import * as symbolUtils from "@arcgis/core/symbols/support/symbolUtils";

对象： esri/symbols/support/symbolUtils

自从：用于 JavaScript 4.11 的 ArcGIS API

用法说明

symbolUtils.renderPreviewHTML函数(或属性)的定义如下：

renderPreviewHTML (symbol, options) {Promise<HTMLElement>}

生成可以在自定义小部件或其他 DOM 元素中显示的给定符号的预览图像。

参数：

规格：

类型说明

symbol Symbol

要为其生成预览图像的符号。

options Object

可选的

符号预览图像的格式选项。

规格：

node

HTMLElement

可选的

要附加到符号的父节点。

size

Number|Object

可选的

使用数字为表示点的任何符号设置符号预览的大小(以磅为单位)。从版本 4.23 开始，您可以在为 SimpleLineSymbol 和 SimpleFillSymbol 创建预览时提供具有宽度和高度属性的对象。

规格：

width Number	可选的 SimpleLineSymbol 或 SimpleFillSymbol 预览的宽度(以磅为单位)。 SimpleFillSymbol 的预览必须在 `symbolConfig` 中启用 `isSquareFill` 才能使此属性生效。
height Number	可选的 SimpleLineSymbol 或 SimpleFillSymbol 预览的高度(以磅为单位)。 SimpleFillSymbol 的预览必须在 `symbolConfig` 中启用 `isSquareFill` 才能使此属性生效。

maxSize

Number

可选的

符号预览的最大大小(以磅为单位)。

opacity

Number

可选的

symbol 表示的图层的不透明度。必须是 0 到 1 之间的数字。

scale

Boolean

可选的

默认值：真的

当true 时符号预览的大小将在整个符号的测量中包含轮廓。当 false 时，符号预览将不包括尺寸测量中的轮廓，从而匹配视图中的符号大小。

disableUpsampling

Boolean

可选的

指示是否禁用光栅图像的上采样。

symbolConfig

Object|String

可选的

用于设置填充符号预览形状的选项。这可以是单个字符串值(tall 是唯一选项)，也可以是具有配置选项的对象。有关可用配置选项的详细信息，请参见下表。

可能的值："tall"

规格：

isTall Boolean	可选的默认值：错误的为纵向视图中的"tall" 符号设置为`true`。这通常用于 3D 圆柱对象符号。
isSquareFill Boolean	可选的默认值：错误的设置为 `true` 以将预览呈现为正方形而不是通用多边形形状。

rotation

Number

可选的

符号的旋转。

类型	说明
Promise<HTMLElement>	返回给定符号的预览以显示到 DOM。

例子：

// symbol from SimpleRenderer;
const symbol = layer.renderer.symbol.clone();

symbolUtils.renderPreviewHTML(symbol, {
  node: document.getElementById("preview"),
  size: 8
});

相关用法

注：本文由纯净天空筛选整理自arcgis.com大神的英文原创作品 symbolUtils.renderPreviewHTML。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。

基本信息

用法说明

参数：

返回：

例子：