colorRamps

方法概述

方法详细说明

all(){ColorRamp[]}

返回 smartMapping 配色方案中可用的所有色带。

返回

类型	描述
ColorRamp[]	smartMapping 配色方案中所有可用色带的数组。

示例

// returns all color ramps available in the JS API
const ramps = colorRamps.all();

// Renders all color ramps as continuous color ramps in the body of the html
const ramps = colorRamps.all();

ramps.forEach( ramp => {
  const colorRamp = symbolUtils.renderColorRampPreviewHTML(ramp.colors, {
    align: "horizontal"
  });
  body.appendChild(colorRamp);
});

byName(name){ColorRamp}

返回与给定名称相匹配的 smartMapping 配色方案中的可用色带。

参数

name String 所需色带的名称。

返回

类型	描述
ColorRamp	与给定名称相匹配的色带。

示例

// returns the colors of the Flower Field color ramp
const flowerFieldRamp = colorRamps.byName("Flower Field");
const colorRamp = symbolUtils.renderColorRampPreviewHTML(flowerFieldRamp.colors, {
  align: "horizontal"
});
body.appendChild(colorRamp);

byTag(params){ColorRamp[]}

返回与给定标签相匹配的 smartMapping 配色方案中的可用色带。

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 includedTags String[] optional 提供后，将仅返回包含所有匹配标签的色带。 已知标签： light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | colorblind-friendly | diverging | sequential | categorical | heatmap | 3d excludedTags String[] optional 提供后，将仅返回缺少所有已提供标签的色带。 已知标签： light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | colorblind-friendly | diverging | sequential | categorical | heatmap | 3d

返回

类型	描述
ColorRamp[]	与给定标签相匹配的色带。

示例

// returns all bright red color ramps available in the JS API
const ramps = colorRamps.byTag({
  includedTags: [ "reds", "bright" ]
});

names(){String[]}

返回 smartMapping 配色方案中所有可用色带的名称。任何返回的名称都可用于使用 colorSchemes.getSchemeByName() 来查询颜色方案或使用 byName() 来查询色带。

返回

类型	描述
String[]	smartMapping 配色方案中所有可用色带名称的数组。

示例

// returns all color ramp names available in the JS API
const rampNames = colorRamps.names();

类型定义

ColorRamp

定义用于在图表、Renderer 或 ColorVariable 中可视化数据的色带。

属性

name String 色带的唯一名称。

tags String[] 与色带相关联的标签。

colors Color[] 用于显示连续色带的五种颜色数组。

colorsForClassBreaks Object[] 包含范围大小从 1 种颜色到 10 种颜色的渐变数组。所有渐变均是相同配色方案的一部分，但可根据可视化所需渐变的要求提供不同数量的颜色。 规范 colors Color[] 1 到 10 种颜色的数组，用于显示为具有不同或唯一颜色的渐变。 numClasses Number 离散色带中使用的类或颜色数量。