色带

方法概述

方法详述

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

定义用于在图表、渲染器 或 ColorVariable 中可视化数据的颜色渐变。

属性：

name String 四色曲线图的唯一名称。

tags String[] 与四色曲线图关联的标签。

colors Color[] 五种颜色的数组用来显示一个连续的四色曲线图。

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