JavaScript ArcGIS color.createAgeRenderer用法及代碼示例

基本信息

以下是所在類或對象的基本信息。

AMD: require(["esri/smartMapping/renderers/color"], (colorRendererCreator) => { /* code goes here */ });

ESM: import * as colorRendererCreator from "@arcgis/core/smartMapping/renderers/color";

對象： esri/smartMapping/renderers/color

自從：用於 JavaScript 4.2 的 ArcGIS API

用法說明

color.createAgeRenderer函數(或屬性)的定義如下：

createAgeRenderer (params) {Promise<AgeRendererResult>}

自從：ArcGIS 適用於 JavaScript 4.9 的 API

根據一個或多個字段生成表示要素年齡的連續顏色Renderer。特征的年齡是根據給定的 startTime 和 endTime 計算的，其中之一必須是輸入 layer 中的日期字段。此方法生成 Arcade 表達式並計算表達式輸出的統計信息以完成此操作。生成的渲染器包含一個連續的顏色視覺變量，它將基於視圖背景的最佳顏色映射到基於表達式的結果統計數據的數據值。

您需要提供 layer 、 view 、 startTime 和 endTime 來生成此渲染器。或者，您可以為可視化設置 unit 和 theme。提供其他選項是為了方便更多涉及的自定義可視化創作應用程序。例如，如果您已經在另一個操作中生成了統計信息，則可以將統計信息對象傳遞給 statistics 參數以避免對服務器進行額外調用。

參數：

規格：

類型說明

params Object

用於為從開始和/或結束日期字段返回的時間數據生成年齡的連續顏色可視化的輸入參數。有關每個參數的詳細信息，請參見下表。

規格：

layer

為其生成可視化的圖層。

view

View

渲染輸入層的視圖。此方法檢查視圖的背景(即底圖、Web Map背景或視圖容器)以確定輸出渲染器的最佳顏色。

startTime

Date|String|Number

字段的名稱，或表示年齡計算中開始時間的日期值。如果指定了日期值，則 endTime 參數必須引用圖層中的日期字段。

endTime

Date|String|Number

字段的名稱，或表示年齡計算中結束時間的日期值。如果指定了日期值，則 startTime 參數必須引用圖層中的日期字段。

unit

String

可選的

用於計算 endTime 和 startTime 之間差異的時間單位。如果未指定單位，則根據數據的分布和分布確定建議的單位。

maxValue

Number

可選的

設置可視化的最大年齡。即使存在高於此值的數據，也隻會計算 minValue 和 maxValue 之間的值的統計信息。在 4.15 版添加。

minValue

Number

可選的

設置可視化的最小年齡。即使存在低於此值的數據，也隻會計算 minValue 和 maxValue 之間的值的統計信息。在 4.15 版添加。

theme

String

可選的

默認值：high-to-low

確定將在連續漸變和Map中強調哪些值。下麵列出了可能的值。

值	說明	示例
high-to-low	用強烈的顏色強調高值。高於平均值一個標準偏差的數據值被指定為最強的顏色。低於平均值一個標準偏差的數據值被指定為最弱的顏色。所有其他值都被插值。
above	用強烈的顏色強調高值。最大數據值被分配最強的顏色。中間或平均數據值被分配最弱的顏色。所有其他值都被插值。
below	用強烈的顏色強調低值。最小數據值被分配最強的顏色。中間或平均數據值被分配最弱的顏色。所有其他值都被插值。
above-and-below	以有意義的數據值(例如平均值)為中心的值用弱顏色顯示，而其他值用強顏色強調。所有其他值都被插值。
centered-on	以有意義的數據值(例如平均值)為中心的值用強烈的顏色強調，而其他值用弱的顏色顯示。所有其他值都被插值。
extremes	用強烈的顏色強調高值和低值。所有其他人都用弱顏色可視化。所有其他值都被插值。

outlineOptimizationEnabled

Boolean

可選的

默認值：錯誤的

僅適用於多邊形圖層。指示多邊形輪廓寬度是否應根據視圖比例而變化。設置後，必須在 view 參數中提供有效的 MapView 實例。 3D SceneViews 不支持此選項。

sizeOptimizationEnabled

Boolean

可選的

默認值：錯誤的

僅適用於點和折線圖層。指示符號大小是否應根據視圖比例而變化。設置後，必須在 view 參數中提供有效的 MapView 實例。 3D SceneViews 不支持此選項。

legendOptions

Object

可選的

提供用於修改說明可視化的Legend 屬性的選項。

規格：

title String	可選的 Legend 中用於表示年齡顏色漸變的標題。
showLegend Boolean	可選的指示是否在圖例中包含年齡渲染器。

statistics

SummaryStatisticsResult

可選的

從 summaryStatistics 函數生成的統計對象。 createAgeRenderer() 方法生成 Arcade 表達式並針對該層執行統計查詢以獲取表達式的結果。如果已經生成了表達式的統計信息，則在此處傳遞對象以避免進行第二次統計查詢。

colorScheme

ColorScheme

可選的

在創作應用程序中，用戶可以選擇預定義的配色方案。將方案對象傳遞給此屬性以避免基於 theme 和視圖背景獲取一個。

symbolType

String

可選的

默認值：二維

要生成的符號類型。這取決於您正在使用的視圖和所需的可視化。不需要為具有mesh 幾何類型的圖層指定此參數。可能的值如下所述。

值	說明
2d	使用 2D 符號(例如 SimpleMarkerSymbol 、 SimpleLineSymbol 或 SimpleFillSymbol )生成可視化。如果為 MapView 中的數據生成可視化，請使用此選項。
3d-flat	使用具有平麵符號圖層(例如 IconSymbol3DLayer 、 LineSymbol3DLayer 或 FillSymbol3DLayer )的 3D 符號生成可視化。如果為 SceneView 中的數據生成 2D 可視化，請使用此選項。
3d-volumetric	使用具有體積符號圖層的 3D 符號生成可視化，例如 ObjectSymbol3DLayer 、 PathSymbol3DLayer 或 ExtrudeSymbol3DLayer 。如果為 SceneView 中的數據生成 3D 可視化，請使用此選項。如果使用此選項，則必須向 `view` 參數提供 SceneView 實例。
3d-volumetric-uniform	使用具有體積符號圖層的統一大小的 3D 符號生成可視化。如果為 SceneView 中的數據生成 3D 可視化，並且符號的大小應一致，例如球體，請使用此選項。如果使用此選項，則必須向 `view` 參數提供 SceneView 實例。

可能的值："2d"|"3d-flat"|"3d-volumetric"|"3d-volumetric-uniform"

defaultSymbolEnabled

Boolean

可選的

默認值：真的

在渲染器上啟用 defaultSymbol 並將其分配給沒有值的函數。

colorMixMode

String

可選的

默認值：代替

此選項僅適用於生成網格 SceneLayers 的渲染器.指定符號顏色如何應用於幾何顏色/紋理。請參閱中的文檔FillSymbol3DLayer.material了解更多上下文。有關可能的值，請參見下表。

值	說明
tint	將符號 `color` 應用於去飽和幾何體/紋理顏色。
replace	移除幾何/紋理顏色並應用符號 `color` 。
multiply	將幾何/紋理顏色值與符號 `color` 值相乘。結果是顏色較深。與白色相乘可保持幾何顏色相同。

signal

AbortSignal

可選的

允許可取消的請求。如果取消，promise 將被拒絕，並出現名為 AbortError 的錯誤。另見AbortController。

類型	說明
Promise<AgeRendererResult>	解析為 AgeRendererResult 的實例。

例子：

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/311_Service_Requests_from_2015_50k/FeatureServer/0"
});

// visualization based age of incidents closed passed their due date
// or the number of days an incident was overdue at the time of closure.

const ageParams = {
  layer: layer,
  view: view,
  startTime: "Due_Date",
  endTime: "Closed_Date",
  unit: "days",
  theme: "above-and-below"
};

// when the promise resolves, apply the renderer to the layer
colorRendererCreator.createAgeRenderer(ageParams)
  .then(function(response){
    layer.renderer = response.renderer;
  });

const layer = new CSVLayer({
  url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_week.csv",
  copyright: "USGS Earthquakes"
});

// visualization based off current age of incident
const ageParams = {
  layer: layer,
  view: view,
  startTime: "time",
  endTime: Date.now(),
  legendOptions: {
    title: "Time since earthquake struck"
  }
};

// when the promise resolves, apply the renderer to the layer
colorRendererCreator.createAgeRenderer(ageParams)
  .then(function(response){
    layer.renderer = response.renderer;
  });

相關用法

注：本文由純淨天空篩選整理自arcgis.com大神的英文原創作品 color.createAgeRenderer。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。

基本信息

用法說明

參數：

返回：

例子：