• geoscene/smartMapping

pieChart

AMD: require(["geoscene/smartMapping/renderers/pieChart"], (pieChartRendererCreator) => { /* code goes here */ });
ESM: import * as pieChartRendererCreator from "@geoscene/core/smartMapping/renderers/pieChart";
类: geoscene/smartMapping/renderers/pieChart
起始版本:GeoScene Maps SDK for JavaScript 4.24

此对象包含一个辅助方法,用于为每个要素生成一个饼图。

例如,假设有包含中国多个县的图层,其中字段包含各种作物的总销售额:小麦、大豆、玉米、棉花和蔬菜。您可使用此模块中的 createRenderer() 方法为每个要素生成一个图表,以可视化每个县中每种作物类型的比例。

已知限制

  • 仅在 2D MapView 中受支持。
  • 仅支持 pointpolygon 几何的图层。
另请参阅

方法概述

名称 返回值类值 描述 对象
Promise<RendererResult>

基于一组数字字段生成一个 PieChartRenderer

更多详情
pieChart
Promise<ClusterRendererResult>

基于输入图层的 UniqueValueRendererClassBreaksRenderer 生成一个 PieChartRenderer 以用于 FeatureReductionCluster 可视化。

更多详情
pieChart

方法详细说明

createRenderer(params){Promise<RendererResult>}

基于一组数字字段生成一个 PieChartRenderer

参数
规范
params Object

输入参数,用于根据一组数字字段生成饼图可视化。各参数的详细信息见下表。

规范

为其生成可视化效果的图层。

view MapView

将在其中渲染可视化的视图实例。

attributes Object[]

一组用于创建图表的互补数字字段/表达式。例如,如果创建一个选举地图,您需指示表示存储其总选票的候选人或政党的每个字段的名称。

规范
field String
optional

数值字段的名称。

label String
optional

描述图例中字段名称 (或饼图切片) 的标注。如果给定字段没有直观的字段名称或别名,则应使用此选项。例如,对于名为 dem 的字段 (表示民主党的总选票计数),您可将标注设置为 Democrat,以明确最终可视化中类别的名称。

valueExpression String
optional

遵循 Arcade 可视化配置文件定义的规范的 Arcade 表达式 表达式。表达式可以使用 $feature 配置变量来引用字段值,并且必须返回一个数字。此属性覆盖 field 属性,因此用于代替输入 field 值 (如果同时指定)。

valueExpressionTitle String
optional

描述从 valueExpression 返回的值的文本。这将显示在图例中。

shape String
optional
默认值:"pie"

确定是创建饼图还是圆环图。

可能值"pie"|"donut"

includeSizeVariable Boolean
optional

表示是否在最终渲染器中包含数据驱动的大小。如果为 true,则将根据 attributes 参数中所有值的总和为要素分配大小。总计数较小的要素将使用小图表显示大小,而总计数较大的要素将使用大图表显示大小。启用此选项有助于可视化特定要素与整个数据集相比的影响力。它消除了由地理面积较大但数据值相对较小的要素带来的偏差。

outlineOptimizationEnabled Boolean
optional
默认值: false

仅适用于面图层。指示多边形的背景填充符号轮廓宽度是否应根据视图比例而变化。

sizeOptimizationEnabled Boolean
optional
默认值: false

指示图表大小是否应根据视图比例而变化。

legendOptions Object
optional

提供用于修改 Legend 属性 (用于描述可视化效果) 的选项。

规范
title String
optional

用于描述 Legend 中的渲染器的标题。

pieChartScheme PieChartScheme
optional

在制作应用程序中,用户可以选择预定义的颜色方案。将方案对象传递到此属性,以避免基于 view 的背景获取方案对象。

forBinning Boolean
optional

指示生成的渲染器是否用于图格可视化。如果为 true,则此方法中的输入字段应引用该图层的 featureReduction 属性中定义的聚合字段

optional

允许可取消的请求。如果取消,则承诺将被拒绝,并返回一个名为 AbortError 的错误。另请参见 AbortController

返回
类型 描述
Promise<RendererResult> 解析为 RendererResult 的实例。
示例
const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/USA_County_Crops_2007/FeatureServer/0"
});

// will create a visualization of predominant crop by U.S. county

const params = {
  layer: layer,
  view: view,
  attributes: [{
    field: "M217_07",
    label: "Vegetables"
  }, {
    field: "M188_07",
    label: "Cotton"
  }, {
    field: "M172_07",
    label: "Wheat"
  }, {
    field: "M193_07",
    label: "Soybeans"
  }, {
    field: "M163_07",
    label: "Corn"
  }],
  includeSizeVariable: true,
  sizeOptimizationEnabled: true,
  shape: "donut"
};

// when the promise resolves, apply the renderer to the layer
const { renderer } = await pieChartRendererCreator.createRenderer(params);
layer.renderer = renderer;
createRendererForClustering(params){Promise<ClusterRendererResult>}
起始版本:GeoScene Maps SDK for JavaScript 4.25

基于输入图层的 UniqueValueRendererClassBreaksRenderer 生成一个 PieChartRenderer 以用于 FeatureReductionCluster 可视化。此方法还可生成聚合字段,这些字段必须提供给 FeatureReductionCluster 对象才能正确地渲染。

参数
规范
params Object

输入参数,用于生成用于聚类的饼图可视化。各参数的详细信息见下表。

规范

为其生成可视化效果的图层。要使用输出聚类渲染器,必须首先在图层上启用聚类。

shape String
optional
默认值:"pie"

确定是创建饼图还是圆环图。

可能值"pie"|"donut"

defaultSymbolEnabled Boolean
optional
默认值:true

在输出饼图渲染器中,包含输入图层渲染器中定义的 defaultSymbol

legendOptions Object
optional

提供用于修改 Legend 属性 (用于描述可视化效果) 的选项。

规范
title String
optional

用于描述 Legend 中的渲染器的标题。

optional

允许可取消的请求。如果取消,则承诺将被拒绝,并返回一个名为 AbortError 的错误。另请参见 AbortController

返回
类型 描述
Promise<ClusterRendererResult> 解析为 ClusterRendererResult 的实例。
示例
const { renderer, fields } = await pieChartRendererCreator.createRendererForClustering({
  layer,
  shape: "donut"
});

const featureReduction = {
  type: "cluster",
  renderer,
  fields
};

layer.featureReduction = featureReduction;

类型定义

ClusterRendererResult

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

属性

用于聚类的生成的饼图渲染器。在 FeatureReductionCluster 实例的 renderer 属性上设置此值,以更新其可视化效果。

renderer 使用的聚合字段。在 renderer 旁的 FeatureReductionCluster 实例的 fields 属性上设置此值,以将聚类可视化更新为饼图。

RendererResult

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

属性

生成的饼图渲染器。在图层的 renderer 属性上对它进行设置以更新其可视化效果。

optional

大小视觉变量,表示饼图中包含的所有属性的总数。如果参数 includeSizeVariable 为 true,则返回该变量。

pieChartScheme PieChartScheme

渲染器使用的配色方案。

basemapId String

用于确定图表的最佳配色方案的底图 ID。

basemapTheme String

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

包含渲染器中使用的每个属性的总数。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息