pieChart

方法概述

方法详细说明

cloneScheme(scheme){PieChartScheme}

克隆饼图方案对象。

参数

scheme PieChartScheme 要克隆的饼图方案对象。

返回

类型	描述
PieChartScheme	返回给定饼图方案对象的克隆。

示例

// clones the primary scheme returned from the getSchemes() method
const pieChartScheme = primaryScheme.clone();

getSchemeByName(params){PieChartScheme}

返回具有给定名称的饼图方案。

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 name String 要检索的方案的名称。 basemap String|Basemap optional 与可视化配对的底图。此值表示使用给定底图进行可视化图表的最佳颜色。 basemapTheme String optional 如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用此参数来表示可视化的背景是 light 还是 dark。 可能值："light"|"dark" geometryType String 要可视化的要素的几何类型。 可能值："point"|"polygon" numColors Number 要包含在饼图中的值数。

返回

类型	描述
PieChartScheme	返回具有给定名称的饼图方案。

示例

// Returns the Flower Field scheme
let flowerFieldScheme = pieChartSchemes.getSchemeByName({
  name: "Flower Field",
  basemap: map.basemap,
  geometryType: featureLayer.geometryType
});

getSchemes(params){PieChartSchemes}

返回主要方案和次要方案，用于定义饼图可视化的属性。basemap 参数可确定用于可视化每个饼图切片的颜色。

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 basemap String|Basemap optional 与可视化配对的底图。此值表示针对给定底图进行可视化图表的最佳颜色方案。如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可改为使用 basemapTheme 参数。 basemapTheme String optional 如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用此参数来表示可视化的背景是 light 还是 dark。 可能值："light"|"dark" geometryType String 要可视化的要素的几何类型。 可能值："point"|"polygon" numColors Number 在饼图可视化中包含的唯一值的数量。

返回

类型	描述
PieChartSchemes	返回一个对象，其中包含要用于给定底图的最佳饼图方案；它还包含次要方案。

示例

// gets the primary scheme for the features of the given geometry type and basemap
const { primaryScheme, secondarySchemes } = pieChartSchemes.getSchemes({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType
});

// primaryScheme is the suggested default scheme for the layer and basemap

getSchemesByTag(params){PieChartScheme[]}

返回具有所提供标签的饼图方案数组。这些方案定义了可使用 PieChartRenderer 渲染的任何图层中的饼图属性。

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 includedTags String[] optional 提供后，将仅返回包含所有匹配标记的方案。 已知标签： light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | deuteranopia | protanopia | tritanopia | grayscale | types | dot-density excludedTags String[] optional 提供后，将仅返回缺少所有已提供标记的方案。 已知标签： light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | deuteranopia | protanopia | tritanopia | grayscale | types | dot-density basemap String|Basemap optional 与可视化配对的底图。此值表示使用给定底图进行可视化图表的最佳颜色。 basemapTheme String optional 如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用此参数来表示可视化的背景是 light 还是 dark。 可能值："light"|"dark" geometryType String 要可视化的要素的几何类型。 可能值："point"|"polygon" numColors Number 在饼图可视化中包含的类别数。

返回

类型	描述
PieChartScheme[]	返回包含或排除所提供标签的饼图方案数组。

示例

let schemes = pieChartSchemes.getSchemesByTag({
  includedTags: [ "types", "reds" ],
  basemap: map.basemap,
  geometryType: featureLayer.geometryType
});

getThemes(basemap){Theme[]}

返回可用主题的元数据。如果提供了底图，则返回与给定底图最匹配的主题。

参数

basemap String|Basemap optional GeoScene 底图字符串或将与返回的主题一起使用的对象。

返回

类型	描述
Theme[]	回一个对象，其中包含有关给定底图的可用主题的信息。

类型定义

PieChartScheme

定义用于可视化饼图的颜色和方案的属性。

属性

name String 配色方案的唯一名称。

tags String[] 与颜色方案关联的标签。

colors Color[] 用于在图表中可视化饼图切片的颜色。

colorForOthersCategory Color “其他”类别的颜色。

outline Object 用于定义饼图轮廓的属性。 规范 color Color 饼图的轮廓颜色。 width Number|String 轮廓的宽度，以磅为单位。

sizeScheme SizeScheme 定义大小视觉变量的方案，用于更改每个要素的图表大小。

size Number|String 饼图的默认大小，以像点或像素为单位。

PieChartSchemes

getSchemes() 方法返回的对象。

属性

primaryScheme PieChartScheme 基于给定底图的建议默认图表方案。

secondarySchemes PieChartScheme[] 可用于可视化叠加在给定底图上的数据的其他图表方案。

basemapId String 与给定方案相关联的底图 ID。

basemapTheme String 表示平均底图颜色是 light 还是 dark。