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。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。

基本信息

用法說明

參數：

返回：

例子：