heatmap

方法概述

方法详细说明

cloneScheme(scheme){HeatmapScheme}

克隆一个热点图方案对象。

参数

scheme HeatmapScheme 要克隆的热点图方案对象。

返回

类型	描述
HeatmapScheme	给定热点图方案对象的克隆。

示例

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

getSchemeByName(params){HeatmapScheme}

起始版本：GeoScene Maps SDK for JavaScript 4.12

返回具有提供名称的热点图方案。

参数

规范

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

返回

类型	描述
HeatmapScheme	返回具有给定名称的热点图方案。

示例

// Returns the Heatmap 4 scheme
let heatmapScheme = heatmapSchemes.getSchemeByName({
  basemap: map.basemap,
  name: "Heatmap 4"
});

getSchemes(params){HeatmapSchemes}

返回主要方案和次要方案，用于定义点图层中热点图可视化的属性。basemap 参数可确定热点图的配色方案。

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 basemap String|Basemap optional 与可视化配对的底图。此值表示针对给定底图进行可视化要素的最佳颜色。如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用 basemapTheme 参数而不是此参数。 basemapTheme String optional 如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用此参数来表示可视化的背景是 light 还是 dark。 可能值："light"|"dark"

返回

类型	描述
HeatmapSchemes	返回一个对象，其中包含要用于给定底图的最佳热点图方案以及也可使用的次要方案。

示例

// gets the primary scheme for the basemap
let schemes = heatmapSchemes.getSchemes({
  basemap: map.basemap
});

// the best default scheme for the layer, basemap, and theme
let primaryScheme = schemes.primaryScheme;

getSchemesByTag(params){HeatmapScheme[]}

起始版本：GeoScene Maps SDK for JavaScript 4.12

返回具有所提供标签的热点图方案数组。这些方案可为使用 HeatmapRenderer 渲染的任何图层定义色标属性。

参数

规范

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"

返回

类型	描述
HeatmapScheme[]	返回包含或排除所提供标记的热点图方案数组。

示例

// Returns all the heatmap schemes that look good in grayscale
let grayscaleSchemes = heatmapSchemes.getSchemesByTag({
  basemap: map.basemap,
  includedTags: [ "heatmap", "grayscale" ]
});

getThemes(basemap){Theme[]}

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

参数

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

返回

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

类型定义

HeatmapScheme

定义符号系统方案的属性，该方案用于将点要素可视化为热点图。

属性

name String 方案的唯一名称。

tags String[] 与方案相关的标签。

id String 要在可视化中使用的配色方案的唯一 ID。Id 是根据以下模板分配的：<themeName>/<basemapName>/<schemeName>。

colors Color[] 用于构造热点图的连续色带。

opacity Number 热点图的不透明度。

HeatmapSchemes

getSchemes() 方法返回的对象。

属性

primaryScheme HeatmapScheme 最适合给定底图和几何类型的热点图配色方案。

secondarySchemes HeatmapScheme[] 可用于可视化叠加在给定底图上的数据的其他热点图配色方案。

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

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