color

方法概述

方法详细说明

createAgeRenderer(params){Promise<AgeRendererResult>}

起始版本：GeoScene Maps SDK for JavaScript 4.9

生成一个连续颜色渲染器，表示基于一个或多个字段的要素期限。要素年龄是根据给定的 startTime 和 endTime 计算的，其中一个必须是输入 layer 中的日期字段。此方法生成一个 Arcade 表达式，并计算表达式输出的统计信息以实现此目的。生成的渲染器包含一个连续的颜色视觉变量，该变量根据视图的背景将最佳颜色映射到基于表达式的结果统计信息的数据值。

您需要提供 layer、view、startTime 和 endTime 来生成此渲染器。或者, 您可为可视化效果设置 unit 和 theme。为方便自定义更复杂的可视化创作应用程序，还提供了其他选项。例如，如果已在另一操作中生成了统计信息，则可将统计对象传递给 statistics 参数，以避免对服务器进行额外的调用。

参数

规范

params Object 输入参数，用于为从开始和/或结束日期字段返回的时间数据生成年龄的连续颜色可视化。各参数的详细信息见下表。 规范 layer FeatureLayer|SceneLayer|CSVLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer 为其生成可视化效果的图层。 view View 渲染输入图层的视图。此方法可检查视图的背景 (即底图、web 地图背景或视图容器)，以确定输出渲染器的最佳颜色。 startTime Date|String|Number 字段的名称，或表示年龄计算的开始时间的日期值。如果指定了日期值，则 endTime 参数必须引用图层中的 Date 字段。 endTime Date|String|Number 字段的名称，或表示年龄计算的结束时间的日期值。如果指定了日期值，则 startTime 参数必须引用图层中的 Date 字段。 unit String optional 用于计算 endTime 和 startTime 之间差值的时间单位。如果未指定单位，则根据数据的分布确定建议的单位。 可能值："years"|"months"|"days"|"hours"|"minutes"|"seconds" maxValue Number optional 设置可视化效果的最长期限。即使存在高于此值的数据，也只会计算 minValue 和 maxValue 之间的值的统计信息。在版本 4.15 中添加。 minValue Number optional 设置可视化效果的最小期限。即使存在低于此值的数据，也只会计算 minValue 和 maxValue 之间的值的统计信息。在版本 4.15 中添加。 theme String optional 默认值：high-to-low 确定将在连续色带和地图中强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。为高于平均值一个标准差的数据值分配最深的颜色。为低于平均值一个标准差的数据值分配最浅的颜色。对所有其他值进行插值。 above 使用深色强调高值。为最大数据值分配最深的颜色。为中间值或平均数据值分配最浅的颜色。对所有其他值进行插值。 below 使用深色强调低值。为最小数据值分配最深的颜色。为中间值或平均数据值分配最浅的颜色。对所有其他值进行插值。 above-and-below 以有意义的数据值 (例如，平均值) 为中心的值使用浅色进行可视化，而其他值则使用深色进行强调。对所有其他值进行插值。 centered-on 以有意义的数据值 (例如，平均值) 为中心的值使用深色强调，而其他值使用浅色进行可视化。对所有其他值进行插值。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。对所有其他值进行插值。 可能值："high-to-low"|"above"|"below"|"above-and-below"|"centered-on"|"extremes" outlineOptimizationEnabled Boolean optional 默认值： false 仅适用于面图层。指示多边形轮廓宽度是否应根据视图比例而变化。设置后，必须在 view 参数中提供有效的 MapView 实例。3D SceneViews 不支持此选项。 sizeOptimizationEnabled Boolean optional 默认值： false 仅适用于点和折线图层。指示符号大小是否应根据视图比例而变化。设置后，必须在 view 参数中提供有效的 MapView 实例。3D SceneViews 不支持此选项。 legendOptions Object optional 提供用于修改 Legend 属性 (用于描述可视化效果) 的选项。 规范 title String optional 用于表示 Legend 中年龄色带的标题。 showLegend Boolean optional 指示是否在图例中包括期限渲染器。 statistics SummaryStatisticsResult optional 从 summaryStatistics 函数生成的统计信息对象。createAgeRenderer() 方法可生成一个 Arcade 表达式，并对图层执行该表达式结果的统计查询。如果已生成表达式的统计信息，则在此处传递对象以避免进行第二次统计信息查询。 colorScheme ColorScheme optional 在制作应用程序中，用户可以选择预定义的颜色方案。将方案对象传递到此属性，以避免基于 theme 和视图的背景获取方案对象。 symbolType String optional 默认值：2d 要生成的符号类型。这取决于您正在使用的视图和所需的可视化效果。对于具有 mesh 几何类型的图层，不需要指定此参数。下面描述了可能的值。 值 描述 2d 使用 2D 符号生成可视化，如 SimpleMarkerSymbol、SimpleLineSymbol 或 SimpleFillSymbol。如果为 MapView 中的数据生成可视化效果，请使用此选项。 3d-flat 使用具有平面符号图层的 3D 符号生成可视化，例如 IconSymbol3DLayer、LineSymbol3DLayer 或 FillSymbol3DLayer。如果为 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 optional 默认值：true 在渲染器上启用 defaultSymbol，并将其分配给没有值的要素。 colorMixMode String optional 默认值：replace 此选项仅适用于为网格 SceneLayers 生成渲染器。指定如何将符号的颜色应用于几何颜色/纹理。有关更多上下文，请参阅 FillSymbol3DLayer.material 文档。有关可能的值，请参见下表。 值 描述 tint 将符号 color 应用于不饱和的几何体/纹理颜色。 replace 移除几何/纹理颜色并应用符号color。 multiply 将几何图形/纹理颜色值与符号 color 值相乘。结果是颜色变深。与白色相乘可使几何图形颜色保持不变。 signal AbortSignal optional 允许可取消的请求。如果取消，则承诺将被拒绝，并返回一个名为 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;
  });

createClassBreaksRenderer(params){Promise<ClassBreaksRendererResult>}

起始版本：GeoScene Maps SDK for JavaScript 4.6

生成一个 ClassBreaksRenderer，可直接将其应用于用于调用此方法的图层。生成的渲染器可根据给定 field 值定义每个要素的符号颜色。默认配色方案是根据视图的背景确定的。基于 classificationMethod，根据数据的统计信息生成分类间隔 (或数据范围)。根据 field 值所在的分类间隔，为每个要素指定一种颜色。

在大多数情况下，您将提供 layer、view、field 和 classificationMethod 来生成此渲染器。在这种情况下，数据的统计信息不是众所周知的，并且用户不知道要在可视化中使用什么颜色。您还可以使用 valueExpression 而不是 field，根据从运行时执行的脚本返回的值来可视化要素。

为方便自定义更复杂的可视化创作应用程序，还提供了其他选项。

参数

规范

params Object 输入参数，用于根据从给定字段或表达式返回的数据生成分类颜色可视化效果。各参数的详细信息见下表。 规范 layer FeatureLayer|SceneLayer|CSVLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer 为其生成可视化效果的图层。 view View optional 渲染输入图层的视图。此方法可检查视图的背景 (即底图、web 地图背景或视图容器)，以确定输出渲染器的最佳颜色。在实践中应始终设置此参数，但如果未提供，此方法将假定生成的渲染器显示在浅色背景上。使用 valueExpression 创建渲染器或用于在 SceneView 中显示的渲染器时，此参数是必需的。 field String optional 将查询其数据以进行统计和分类的字段名称。如果使用 valueExpression，则忽略此属性。 normalizationField String optional 用于规范化给定 field 值的字段名称。提供规范化字段有助于最大限度地减少一些可视化错误并标准化数据，因此，由于面积的差异或计数变化，所有要素都以最小的偏差可视化。此选项通常在可视化密度时使用。 normalizationType String optional 指示如何对数据进行归一化。在与分类间隔进行比较之前，从 field 中获取的数据值将通过以下方式之一进行规范化。有关可能值列表，请参见下表。 可能值 描述 field 将 field 值除以 normalizationField 的值。如果提供了 normalizationField，则默认设置此值。 log 计算数据值的以 10 为底数的对数。对于某些数据分布，这可能是一种有用的方法，因为它可减少非常大的数据值的影响。 percent-of-total 将数据值除以所有数据值的总和，然后乘以 100。使用 normalizationTotal 来定义标准化的总值。如果提供了 normalizationTotal，则默认设置此值。 除了 log 归一化外，数据归一化通过除以两个值来创建一个比率。在比较要素之间的属性值时，归一化可将不同地图区域和观测数量的影响降至最低。例如，将 18 到 30 岁的人口除以面要素的面积，可以得到一个密度值，该值可以在被忽略其面积大小情况下，与其他要素进行均匀比较。 可能值："field"|"log"|"percent-of-total" normalizationTotal Number optional 当 normalizationType 为 percent-of-total 时，此属性包含所有数据值的总计。 classificationMethod String optional 默认值： equal-interval 用于生成分类间隔的分类方法。有关可能值列表，请参见下表。 可能值 描述 equal-interval 将属性值的范围划分为大小相等的子范围。例如，如果为值范围为 0 到 300 的字段指定三个类，则此方法将创建三个范围分别为 0–100、101–200 和 201–300 的类。相等间隔最适合应用于熟悉的数据范围，例如百分比和温度。此方法强调属性值相对于其他值的数量。例如，它可以显示商店是否是构成所有销售额前三分之一的商店组的一部分。 natural-breaks 对相似值进行分组，以最大化类之间的差异。要素被划分为多个类，其边界设置在数据值存在较大差异的地方。自然间断是特定于数据的分类，对于比较根据不同基础信息构建的多个地图没有用处。 quantile 为每个类分配相同数量的数据值。这非常适合线性分布的数据。由于要素在每个类中以相等的数量进行分组，因此生成的地图通常具有误导性。相似要素可以放置在相邻的类中，或者具有截然不同值的要素可以放在同一个类中。您可以通过增加类的数量来最大程度地减少这种失真。 standard-deviation 创建具有等值范围的分类间隔，这些范围是标准差的一部分。这通常以与平均值相差一、二分之一、三分之一或四分之一的标准偏差的间隔来完成。 可能值："equal-interval"|"natural-breaks"|"quantile"|"standard-deviation" standardDeviationInterval Number optional 默认值：1 如果使用 standard-deviation 分类方法，则表示生成分类间隔的时间间隔。 可能值：1 | 0.5 | 0.33 | 0.25 numClasses Number optional 默认值：5 生成的分类间隔数。如果指定了 standard-deviation 分类方法，则将忽略这一点。 colorScheme ColorScheme optional 在制作应用程序中，用户可以选择预定义的颜色方案。将方案对象传递到此属性，以避免基于视图的背景获取方案对象。 valueExpression String optional 遵循 Arcade 可视化配置文件定义的规范的 Arcade 表达式 表达式。表达式可以使用 $feature 配置变量来引用字段值，并且必须返回一个数字。此属性覆盖 field 属性，因此用于代替输入 field 值。 valueExpressionTitle String optional 描述从 valueExpression 返回的值的文本。这由 Legend 微件使用。 sqlExpression String optional 一个 SQL 表达式，其计算结果为数字。 sqlWhere String optional SQL where 子句，用于过滤统计查询的要素。例如，当您希望避免除以 0 的情况时 (像创建优势可视化的情况那样)，这很有用。 outlineOptimizationEnabled Boolean optional 默认值： false 仅适用于面图层。指示多边形轮廓宽度是否应根据视图比例而变化。设置后，必须在 view 参数中提供有效的 MapView 实例。3D SceneViews 不支持此选项。 legendOptions Object optional 提供用于设置标题以描述字段而不是使用字段名称的选项。此标题将表示 Legend 中的字段。 规范 title String optional 用于表示 Legend 中的给定字段或表达式的标题。 minValue Number optional 用户设置的最小值。将此参数与 maxValue 结合使用以在下限和上限之间生成分类中断。这将是最低分类间隔的下限。 maxValue Number optional 用户设置的最大值。将此参数与 minValue 结合使用以在下限和上限之间生成分类中断。这将是最高分类间隔的上限。 defaultSymbolEnabled Boolean optional 默认值：true 在渲染器上启用 defaultSymbol，并将其分配给没有值的要素以及位于配置数据范围之外的要素。 symbolType String optional 默认值：2d 要生成的符号类型。这取决于您正在使用的视图和所需的可视化效果。对于具有 mesh 几何类型的图层，不需要指定此参数。下面描述了可能的值。 值 描述 2d 使用 2D 符号生成可视化，如 SimpleMarkerSymbol、SimpleLineSymbol 或 SimpleFillSymbol。如果为 MapView 中的数据生成可视化效果，请使用此选项。 3d-flat 使用具有平面符号图层的 3D 符号生成可视化，例如 IconSymbol3DLayer、LineSymbol3DLayer 或 FillSymbol3DLayer。如果为 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" colorMixMode String optional 默认值：replace 此选项仅适用于为网格 SceneLayers 生成渲染器。指定如何将符号的颜色应用于几何颜色/纹理。有关更多上下文，请参阅 FillSymbol3DLayer.material 文档。有关可能的值，请参见下表。 值 描述 tint 将符号 color 应用于不饱和的几何体/纹理颜色。 replace 移除几何/纹理颜色并应用符号color。 multiply 将几何图形/纹理颜色值与符号 color 值相乘。结果是颜色变深。与白色相乘可使几何图形颜色保持不变。 forBinning Boolean optional 指示生成的渲染器是否用于图格可视化。如果为 true，则此方法中的输入字段应引用该图层的 featureReduction 属性中定义的聚合字段。 signal AbortSignal optional 允许可取消的请求。如果取消，则承诺将被拒绝，并返回一个名为 AbortError 的错误。另请参见 AbortController。

返回

类型	描述
Promise<ClassBreaksRendererResult>	解析为 ClassBreaksRendererResult 的实例。

示例

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

// visualization based on field and normalization field
let colorParams = {
  layer: layer,
  view: view,
  field: "POP_POVERTY",
  normalizationField: "TOTPOP_CY",
  classificationMethod: "quantile",
  numClasses: 4
};

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

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

// visualization based off Arcade expression
let colorParams = {
  layer: layer,
  valueExpression: "($feature.POP_POVERTY / $feature.TOTPOP_CY) * 100",
  view: view,
  sqlWhere: "TOTPOP_CY > 0",
  legendOptions: {
    title: "% of people living in poverty"
  }
};

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

createContinuousRenderer(params){Promise<ContinuousRendererResult>}

生成一个渲染器，可直接将其应用于用于调用此方法的图层。渲染器包含一个连续的颜色视觉变量，该变量根据视图背景的最佳颜色映射到基于指示字段或表达式中查询的统计信息的特定停止值。

在大多数情况下，您将提供 layer、view、field 和 theme 来生成此渲染器。在这种情况下，数据的统计信息不是众所周知的，并且用户不知道要在可视化中使用什么颜色。您还可以使用 valueExpression 而不是 field，根据从运行时执行的脚本返回的值来可视化要素。

为方便自定义更复杂的可视化创作应用程序，还提供了其他选项。例如，如果已在另一操作中生成了统计信息，则可将统计对象传递给 statistics 参数，以避免对服务器进行额外的调用。

参数

规范

params Object 输入参数，用于根据从给定字段或表达式返回的数据生成连续颜色可视化效果。各参数的详细信息见下表。 规范 layer FeatureLayer|SceneLayer|CSVLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer 为其生成可视化效果的图层。 view View optional 渲染输入图层的视图。此方法可检查视图的背景 (即底图、web 地图背景或视图容器)，以确定输出渲染器的最佳颜色。在实践中应始终设置此参数，但如果未提供，此方法将假定生成的渲染器显示在浅色背景上。使用 valueExpression 创建渲染器或用于在 SceneView 中显示的渲染器时，此参数是必需的。 field String optional 将查询其数据以进行统计并用作数据驱动可视化的基础的字段名称。如果使用 valueExpression，则忽略此属性。 normalizationField String optional 用于规范化给定 field 值的字段名称。提供规范化字段有助于最大限度地减少一些可视化错误并标准化数据，因此，由于面积的差异或计数变化，所有要素都以最小的偏差可视化。此选项通常在可视化密度时使用。 theme String optional 默认值：high-to-low 确定将在连续色带和地图中强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。为高于平均值一个标准差的数据值分配最深的颜色。为低于平均值一个标准差的数据值分配最浅的颜色。对所有其他值进行插值。 above 使用深色强调高值。为最大数据值分配最深的颜色。为中间值或平均数据值分配最浅的颜色。对所有其他值进行插值。 below 使用深色强调低值。为最小数据值分配最深的颜色。为中间值或平均数据值分配最浅的颜色。对所有其他值进行插值。 above-and-below 以有意义的数据值 (例如，平均值) 为中心的值使用浅色进行可视化，而其他值则使用深色进行强调。对所有其他值进行插值。 centered-on 以有意义的数据值 (例如，平均值) 为中心的值使用深色强调，而其他值使用浅色进行可视化。对所有其他值进行插值。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。对所有其他值进行插值。 可能值："high-to-low"|"above"|"below"|"above-and-below"|"centered-on"|"extremes" colorScheme ColorScheme optional 在制作应用程序中，用户可以选择预定义的颜色方案。将方案对象传递到此属性，以避免基于 theme 和视图的背景获取方案对象。 valueExpression String optional 遵循 Arcade 可视化配置文件定义的规范的 Arcade 表达式 表达式。表达式可以使用 $feature 配置变量来引用字段值，并且必须返回一个数字。此属性覆盖 field 属性，因此用于代替输入 field 值。 valueExpressionTitle String optional 描述从 valueExpression 返回的值的文本。这由 Legend 微件使用。 sqlExpression String optional 一个 SQL 表达式，其计算结果为数字。 sqlWhere String optional SQL where 子句，用于过滤统计查询的要素。例如，当您希望避免除以 0 的情况时 (像创建优势可视化的情况那样)，这很有用。 outlineOptimizationEnabled Boolean optional 默认值： false 仅适用于面图层。指示多边形轮廓宽度是否应根据视图比例而变化。设置后，必须在 view 参数中提供有效的 MapView 实例。3D SceneViews 不支持此选项。 sizeOptimizationEnabled Boolean optional 默认值： false 仅适用于点和折线图层。指示符号大小是否应根据视图比例而变化。设置后，必须在 view 参数中提供有效的 MapView 实例。3D SceneViews 不支持此选项。 legendOptions Object optional 提供选项，用于在提供表达式而不是字段名称时设置字段的标题。此标题将表示 Legend 中的字段。 规范 title String optional 用于表示 Legend 中的给定字段或表达式的标题。 showLegend Boolean optional 指示是否在图例中描述渲染器。 statistics SummaryStatisticsResult optional 从 summaryStatistics 函数生成的统计信息对象。如果已生成了字段的统计信息，则在此处传递对象以避免向服务器进行第二次统计信息查询。 minValue Number optional 用户设置的自定义最小值。将此参数与 maxValue 结合使用可在下限和上限之间生成统计信息。这将是返回的颜色视觉变量中的最低停止点。 maxValue Number optional 用户设置的自定义最大值。将此参数与 minValue 结合使用可在下限和上限之间生成统计信息。这将是返回的颜色视觉变量中的最高停止点。 defaultSymbolEnabled Boolean optional 默认值：true 在渲染器上启用 defaultSymbol，并将其分配给没有值的要素以及位于配置数据范围之外的要素。 symbolType String optional 默认值：2d 要生成的符号类型。这取决于您正在使用的视图和所需的可视化效果。对于具有 mesh 几何类型的图层，不需要指定此参数。下面描述了可能的值。 值 描述 2d 使用 2D 符号生成可视化，如 SimpleMarkerSymbol、SimpleLineSymbol 或 SimpleFillSymbol。如果为 MapView 中的数据生成可视化效果，请使用此选项。 3d-flat 使用具有平面符号图层的 3D 符号生成可视化，例如 IconSymbol3DLayer、LineSymbol3DLayer 或 FillSymbol3DLayer。如果为 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" colorMixMode String optional 默认值：replace 此选项仅适用于为网格 SceneLayers 生成渲染器。指定如何将符号的颜色应用于几何颜色/纹理。有关更多上下文，请参阅 FillSymbol3DLayer.material 文档。有关可能的值，请参见下表。 值 描述 tint 将符号 color 应用于不饱和的几何体/纹理颜色。 replace 移除几何/纹理颜色并应用符号color。 multiply 将几何图形/纹理颜色值与符号 color 值相乘。结果是颜色变深。与白色相乘可使几何图形颜色保持不变。 forBinning Boolean optional 指示生成的渲染器是否用于图格可视化。如果为 true，则此方法中的输入字段应引用该图层的 featureReduction 属性中定义的聚合字段。 signal AbortSignal optional 允许可取消的请求。如果取消，则承诺将被拒绝，并返回一个名为 AbortError 的错误。另请参见 AbortController。

返回

类型	描述
Promise<ContinuousRendererResult>	解析为 ContinuousRendererResult 的实例。

示例

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

// visualization based on field and normalization field
let colorParams = {
  layer: layer,
  view: view,
  field: "POP_POVERTY",
  normalizationField: "TOTPOP_CY",
  theme: "above-and-below"
};

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

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

// visualization based off Arcade expression
let colorParams = {
  layer: layer,
  valueExpression: "($feature.POP_POVERTY / $feature.TOTPOP_CY) * 100",
  view: view,
  sqlWhere: "TOTPOP_CY > 0",
  legendOptions: {
    title: "% of people living in poverty"
  }
};

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

createPCContinuousRenderer(params){Promise<PCContinuousRendererResult>}

起始版本：GeoScene Maps SDK for JavaScript 4.5

基于 PointCloudLayer 的给定字段返回的统计数据，生成一个 PointCloudStretchRenderer，其具有最适合视图背景的配色方案。所需要的只是图层实例、字段名称和底图 ID。您可以选择设置点的大小和密度以满足所需的可视化需求。

参数

规范

params Object 根据输入图层的给定字段生成渲染器的输入参数。各参数的详细信息见下表。 规范 layer PointCloudLayer 为其生成可视化效果的图层。 field String 将查询其数据以进行统计并用作数据驱动可视化的基础的字段名称。用于此渲染器类型的唯一字段名称是 elevation 和 intensity。 basemap String|Basemap optional 默认值： gray 将与输出可视化效果配对的 GeoScene 底图的命名字符串或底图对象。 size String optional 默认值：100% 每个点的大小以百分比表示。该值将确定基于给定点 density 缩放的点大小。当该值为 100% 时，将设置每个点的大小，以使相邻点之间的间隙数量最小化。任何高于 100% 的值都将允许点与缩放到给定值的相邻点重叠。低于 100% 的值可将点缩放至更小的尺寸，以便点之间的间隙似乎更大。 density Number optional 默认值：25 视图中每英寸的点数。 colorScheme ColorScheme optional 在制作应用程序中，用户可以选择预定义的颜色方案。将方案对象传递到此属性，以避免基于 basemap 获取方案对象。 statistics SummaryStatisticsResult optional 从 summaryStatistics 函数生成的统计信息对象。如果已生成字段的统计信息，则在此处传递 stats 对象以避免进行第二次统计信息 signal AbortSignal optional 允许可取消的请求。如果取消，则承诺将被拒绝，并返回一个名为 AbortError 的错误。另请参阅 AbortController 对服务器的查询

返回

类型	描述
Promise<PCContinuousRendererResult>	解析为一个包含渲染器的对象，可以在输入图层上设置。有关更多详情，请参阅 PCContinuousRendererResult。

示例

let layer = new PointCloudLayer({
  url: "https://tiles.arcgis.com/tiles/V6ZHFr6zdgNZuVG0/arcgis/rest/services/BARNEGAT_BAY_LiDAR_UTM/SceneServer"
});

let params = {
  layer: layer,
  field: "INTENSITY",
  basemap: "satellite"
};

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

createPCTrueColorRenderer(params){Promise<PCTrueColorRendererResult>}

起始版本：GeoScene Maps SDK for JavaScript 4.5

基于给定 PointCloudLayer 的 RGB 字段生成 PointCloudRGBRenderer。该方法简化了手动创建 PointCloudRGBRenderer 的体验。所需要的只是一个图层实例。您可以选择设置点的大小和密度以满足所需的可视化需求。

参数

规范

params Object 用于根据输入图层的 RGB 字段生成真彩色可视化的输入参数。各参数的详细信息见下表。 规范 layer PointCloudLayer 为其生成可视化效果的图层。 size String optional 默认值：100% 每个点的大小以百分比表示。该值将确定基于给定点 density 缩放的点大小。当该值为 100% 时，将设置每个点的大小，以使相邻点之间的间隙数量最小化。任何高于 100% 的值都将允许点与缩放到给定值的相邻点重叠。低于 100% 的值可将点缩放至更小的尺寸，以便点之间的间隙似乎更大。 density Number optional 默认值：25 视图中每英寸的点数。 signal AbortSignal optional 允许可取消的请求。如果取消，则承诺将被拒绝，并返回一个名为 AbortError 的错误。另请参见 AbortController。

返回

类型	描述
Promise<PCTrueColorRendererResult>	解析为一个包含渲染器的对象，可以在输入图层上设置。有关更多详情，请参阅 PCTrueColorRendererResult。

示例

let layer = new PointCloudLayer({
  url: "https://tiles.arcgis.com/tiles/V6ZHFr6zdgNZuVG0/arcgis/rest/services/BARNEGAT_BAY_LiDAR_UTM/SceneServer"
});

// generates an RGB renderer using default values for the given layer.
colorRendererCreator.createPCTrueColorRenderer({
  layer: layer
}).then(function(response){
  layer.renderer = response.renderer;
});

let layer = new PointCloudLayer({
  url: "https://tiles.arcgis.com/tiles/V6ZHFr6zdgNZuVG0/arcgis/rest/services/BARNEGAT_BAY_LiDAR_UTM/SceneServer"
});

// sets options for configuring size of points
let params = {
  layer: layer,
  density: 25,  // points per square inch
  size: "100%"  // minimizes gap between points
};

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

createVisualVariable(params){Promise<VisualVariableResult>}

此方法生成一个颜色视觉变量，其默认停止点是根据指示的字段或表达式查询的统计信息以及由视图背景确定的颜色来作为最佳选择。

有两种不同方式可以调用此方法。最常见的情况是提供 layer、view、field 和 theme。在这种情况下，数据的统计信息不是众所周知的，并且用户不知道要使用什么颜色。您可选择性地使用 valueExpression 而不是字段，根据从运行时执行的脚本返回的数值来可视化要素。

为方便自定义更复杂的可视化创作应用程序，还提供了其他选项。例如，如果已在另一个操作中生成了统计信息，则可在 statistics 参数中传递对象，以避免对服务器进行额外的调用。如果您不想使用为您挑选的，也可以提供 colorScheme。在这种情况下，将忽略 view 和 theme 选项。

参数

规范

params Object 输入参数，用于根据从给定字段或表达式返回的数据生成颜色视觉变量。各参数的详细信息见下表。 规范 layer FeatureLayer|SceneLayer|CSVLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer 为其生成视觉变量的图层。 view View optional 渲染输入图层的视图。此方法可检查视图的背景 (即底图、web 地图背景或视图容器)，以确定输出渲染器的最佳颜色。在实践中应始终设置此参数，但如果未提供，此方法将假定生成的渲染器显示在浅色背景上。使用 valueExpression 创建渲染器或用于在 SceneView 中显示的渲染器时，此参数是必需的。 field String optional 将查询其数据以进行统计并用作数据驱动可视化的基础的字段名称。如果使用 valueExpression，则忽略此属性。 normalizationField String optional 用于规范化给定 field 值的字段名称。提供规范化字段有助于最大限度地减少一些可视化错误并标准化数据，因此，由于面积的差异或计数变化，所有要素都以最小的偏差可视化。此选项通常在可视化密度时使用。 theme String optional 默认值：high-to-low 确定将在连续色带和地图中强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。为高于平均值一个标准差的数据值分配最深的颜色。为低于平均值一个标准差的数据值分配最浅的颜色。对所有其他值进行插值。 above 使用深色强调高值。为最大数据值分配最深的颜色。为中间值或平均数据值分配最浅的颜色。对所有其他值进行插值。 below 使用深色强调低值。为最小数据值分配最深的颜色。为中间值或平均数据值分配最浅的颜色。对所有其他值进行插值。 above-and-below 以有意义的数据值 (例如，平均值) 为中心的值使用浅色进行可视化，而其他值则使用深色进行强调。对所有其他值进行插值。 centered-on 以有意义的数据值 (例如，平均值) 为中心的值使用深色强调，而其他值使用浅色进行可视化。对所有其他值进行插值。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。对所有其他值进行插值。 可能值："high-to-low"|"above"|"below"|"above-and-below"|"centered-on"|"extremes" colorScheme ColorScheme optional 在制作应用程序中，用户可以选择预定义的颜色方案。将方案对象传递到此属性，以避免基于 theme 和视图的背景获取方案对象。 valueExpression String optional 遵循 Arcade 可视化配置文件定义的规范的 Arcade 表达式 表达式。表达式可以使用 $feature 配置变量来引用字段值，并且必须返回一个数字。此属性覆盖 field 属性，因此用于代替输入 field 值。 valueExpressionTitle String optional 描述从 valueExpression 返回的值的文本。这由 Legend 微件使用。 sqlExpression String optional 一个 SQL 表达式，其计算结果为数字。 sqlWhere String optional SQL where 子句，用于过滤统计查询的要素。例如，当您希望避免除以 0 的情况时 (像创建优势可视化的情况那样)，这很有用。 legendOptions Object optional 提供选项，用于在提供表达式而不是字段名称时设置字段的标题。此标题将表示 Legend 中的字段。 规范 title String optional 用于表示 Legend 中的给定字段或表达式的标题。 showLegend Boolean optional 指示是否在图例中描述渲染器。 statistics SummaryStatisticsResult optional 从 summaryStatistics 函数生成的统计信息对象。如果已生成了字段的统计信息，则在此处传递对象以避免向服务器进行第二次统计信息查询。 minValue Number optional 用户设置的自定义最小值。将此参数与 maxValue 结合使用可在下限和上限之间生成统计信息。这将是返回的颜色视觉变量中的最低停止点。 maxValue Number optional 用户设置的自定义最大值。将此参数与 minValue 结合使用可在下限和上限之间生成统计信息。这将是返回的颜色视觉变量中的最高停止点。 worldScale Boolean optional 表示符号的尺寸单位是否以米为单位。在使用 3D 体积符号系统生成可视化时，这应为 true，具有 mesh 几何类型的图层除外。如果此属性设置为 true，则必须提供 view。 forBinning Boolean optional 指示生成的渲染器是否用于图格可视化。如果为 true，则此方法中的输入字段应引用该图层的 featureReduction 属性中定义的聚合字段。 signal AbortSignal optional 允许可取消的请求。如果取消，则承诺将被拒绝，并返回一个名为 AbortError 的错误。另请参见 AbortController。

返回

类型	描述
Promise<VisualVariableResult>	解析为 VisualVariableResult 的实例。

示例

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

// visualization based on field and normalization field
let colorParams = {
  layer: layer,
  view: view,
  field: "POP_POVERTY",
  normalizationField: "TOTPOP_CY",
  theme: "above-and-below"
};

// when the promise resolves, apply the visual variable to the renderer
colorRendererCreator.createVisualVariable(colorParams)
  .then(function(response){
    let renderer = layer.renderer.clone();
    renderer.visualVariables = [ response.visualVariable ];
    layer.renderer = renderer;
  });

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

// visualization based off Arcade expression
let colorParams = {
  layer: layer,
  view: view,
  valueExpression: "($feature.POP_POVERTY / $feature.TOTPOP_CY) * 100",
  sqlWhere: "TOTPOP_CY > 0",
  legendOptions: {
    title: "% of people living in poverty"
  }
};

// when the promise resolves, apply the visual variable to the renderer
colorRendererCreator.createVisualVariable(colorParams)
  .then(function(response){
    let renderer = layer.renderer.clone();
    renderer.visualVariables = [ response.visualVariable ];
    layer.renderer = renderer;
  });

类型定义

AgeRendererResult

起始版本：GeoScene Maps SDK for JavaScript 4.9

createAgeRenderer() 方法的结果对象。各属性的详细信息见下表。

属性

renderer ClassBreaksRenderer 配置为最匹配视图背景和数据展开的渲染器对象。在图层的 renderer 属性上对它进行设置以更新其可视化效果。

visualVariable ColorVariable 基于数据统计信息和视图背景配置的颜色视觉变量。

unit String 用于在输出 renderer 中表示年龄的时间单位。

colorScheme ColorScheme 视觉变量使用的配色方案。

defaultValuesUsed Boolean 表示在图层中没有足够的数据和/或统计数据时是否使用默认值。当所有要素都具有相同的字段值或根本没有值时，通常使用默认值。

statistics SummaryStatisticsResult 从查询返回给服务的基本统计信息，用于给定字段名称或表达式中的数据。

basemapId String 用于确定要素的最佳填充颜色的底图的 ID。

basemapTheme String 表示输入视图底图的平均颜色是 light 还是 dark。

ClassBreaksRendererResult

起始版本：GeoScene Maps SDK for JavaScript 4.6

createClassBreaksRenderer() 方法的结果对象。各属性的详细信息见下表。

属性

renderer ClassBreaksRenderer 配置为最匹配视图背景和数据展开的渲染器对象。在图层的 renderer 属性上对它进行设置以更新其可视化效果。

classBreaksResult ClassBreaksResult 此对象描述了使用指定分类方法从给定字段的图层数据生成的分类间隔。

colorScheme ColorScheme 用于分类间隔的配色方案。

defaultValuesUsed Boolean 表示在图层中没有足够的数据和/或统计数据时是否使用默认值。当所有要素都具有相同的字段值或根本没有值时，通常使用默认值。

basemapId String 用于确定要素的最佳填充颜色的底图的 ID。

basemapTheme String 表示输入视图底图的平均颜色是 light 还是 dark。

ContinuousRendererResult

createContinuousRenderer() 方法的结果对象。各属性的详细信息见下表。

属性

renderer ClassBreaksRenderer 配置为最佳匹配视图背景和数据分布的渲染器对象。在图层的 renderer 属性 (或 featureReduction.renderer 属性) 上对它进行设置以更新其可视化效果。

visualVariable ColorVariable 基于数据统计信息和视图背景配置的颜色视觉变量。

colorScheme ColorScheme 视觉变量使用的配色方案。

defaultValuesUsed Boolean 表示在图层中没有足够的数据和/或统计数据时是否使用默认值。当所有要素都具有相同的字段值或根本没有值时，通常使用默认值。

statistics SummaryStatisticsResult 从查询返回给服务的基本统计信息，用于给定字段名称或表达式中的数据。

basemapId String 用于确定要素的最佳填充颜色的底图的 ID。

basemapTheme String 表示输入视图底图的平均颜色是 light 还是 dark。

PCContinuousRendererResult

createPCContinuousRenderer() 方法的结果对象。各属性的详细信息见下表。

属性

renderer PointCloudStretchRenderer 配置为最匹配视图背景和数据展开的渲染器对象。在输入图层的 renderer 属性上设置这个对象来更新它的可视化。

colorScheme ColorScheme 渲染器使用的配色方案。

defaultValuesUsed Boolean 表示在图层中没有足够的数据和/或统计数据时是否使用默认值。当所有要素都具有相同的字段值或根本没有值时，通常使用默认值。

statistics SummaryStatisticsResult 从查询返回给服务的基本统计信息，用于给定字段名称中的数据。

basemapId String 用于确定输出渲染器的最佳配色方案的底图 ID。

basemapTheme String 表示输入视图底图的平均颜色是 light 还是 dark。

PCTrueColorRendererResult

createPCTrueColorRenderer() 方法的结果对象。各属性的详细信息见下表。

属性

renderer PointCloudRGBRenderer 配置为表示点云中每个点的真实颜色的渲染器对象。这为 PointCloudLayer 提供了它在现实世界中的外观的真实可视化。在输入图层的 renderer 属性上设置这个对象来更新它的可视化。

VisualVariableResult

createVisualVariable() 方法的结果对象。各属性的详细信息见下表。

属性

visualVariable ColorVariable 基于数据统计信息和视图背景配置的颜色视觉变量。

colorScheme ColorScheme 视觉变量使用的配色方案。

statistics SummaryStatisticsResult 从对服务的查询中返回给定字段或表达式的基本统计信息。

defaultValuesUsed Boolean 表示在图层中没有足够的数据和/或统计数据时是否使用默认值。当所有要素都具有相同的字段值或根本没有值时，通常使用默认值。

basemapId String 用于确定要素的最佳填充颜色的底图的 ID。

basemapTheme String 表示输入视图底图的平均颜色是 light 还是 dark。

authoringInfo AuthoringInfo 与创建视觉变量相关的创作信息。这包括与来自滑块和所选主题的 UI 输入相关的信息。