heatmap

AMD: require(["geoscene/smartMapping/symbology/heatmap"], (heatmapSchemes) => { /* 代码 */ });
ESM: import * as heatmapSchemes from "@geoscene/core/smartMapping/symbology/heatmap";
Object: geoscene/smartMapping/symbology/heatmap
起始版本: GeoScene API for JavaScript 4.22

对象包含用于为热图可视化生成最佳符号的帮助器方法。getSchemes() 方法用于获取最适合给定底图的热图配色方案。

geoscene/renderers/smartMapping/...从 4.16 移出

方法列表

属性 返回值类型 描述 Object
HeatmapScheme更多信息

克隆热图方案对象。

更多信息heatmap
HeatmapScheme更多信息

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

更多信息heatmap
HeatmapSchemes更多信息

回主方案和辅助方案,这些方案定义了点 Layer中热图可视化的属性。

更多信息heatmap
HeatmapScheme[]更多信息

返回具有所提供标记的热图方案数组。

更多信息heatmap
Theme[]更多信息

返回可用主题的元数据。

更多信息heatmap

方法详细说明

cloneScheme(scheme){HeatmapScheme}

克隆热图方案对象。

参数:
scheme HeatmapScheme

要克隆的热图方案对象。

返回值:
类型 描述
HeatmapScheme 给定热图方案对象的克隆。
示例代码:
// clones the primary scheme returned from the getSchemes() method
let heatmapScheme = primaryScheme.clone();
getSchemeByName(params){HeatmapScheme}
起始版本: GeoScene API for JavaScript 4.22

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

参数:
规范:
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}

返回主方案和辅助方案,这些方案定义了点 Layer 中热图可视化的属性。 basemap 参数确定热图的配色方案。

参数:
规范:
params Object

有关可能传递给此函数的每个参数的详细信息,请参见下表。

规范:
basemap String|Basemap
optional

要与可视化效果配对的 GeoScene 底图。此值指示针对给定底图可视化要素的最佳颜色。如果您有非 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 API for JavaScript 4.22

返回具有所提供标记的热图方案数组。这些方案为可以使用 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。 身份证是 根据以下模板分配:<themeName>/<basemapName>/<schemeName>

colors Color[]

用于构造热图的连续色带。

opacity Number

热图的不透明度。

HeatmapSchemes

getSchemes() 方法的返回对象。

属性:
primaryScheme HeatmapScheme

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

secondarySchemes HeatmapScheme[]

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

basemapId String

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

basemapTheme String

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.