color

方法概述

方法详细说明

cloneScheme(scheme){ColorScheme}

克隆一个配色方案对象。

参数

scheme ColorScheme 要克隆的配色方案对象。

返回

类型	描述
ColorScheme	返回给定配色方案对象的克隆。

示例

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

flipColors(scheme){ColorScheme}

以与输入配色方案相反的顺序翻转颜色。

参数

scheme ColorScheme 要反转的配色方案。

返回

类型	描述
ColorScheme	返回输入配色方案及其反向颜色。

示例

// reverses the order of colors in a primary scheme
// obtained from the getSchemes() method
let flippedScheme = colorSchemes.flipColors(primaryScheme);

getMatchingSchemes(params){ColorScheme[]}

起始版本：GeoScene Maps SDK for JavaScript 4.9

返回与给定色带匹配的所有方案。

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 theme String 要从中获取配色方案的主题的名称。 可能值："high-to-low"|"above-and-below"|"centered-on"|"extremes" colors Color[] 用于与给定主题的方案相匹配的颜色数组。 geometryType String 将应用配色方案的图层的几何类型。 worldScale Boolean optional 指示是否在可视化中使用 3D 体积符号。 view SceneView optional 用于计算符号的建议大小的 SceneView 实例。对于 3D 可视化，此为必需项。

返回

类型	描述
ColorScheme[]	与给定颜色相匹配的配色方案数组。

getSchemeByName(params){ColorScheme}

起始版本：GeoScene Maps SDK for JavaScript 4.12

返回具有提供名称的配色方案。

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 name String 要检索的方案的名称。 basemap String|Basemap optional 与可视化配对的底图。此值表示针对给定底图进行可视化要素的最佳符号颜色。 basemapTheme String optional 如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用此参数来表示可视化的背景是 light 还是 dark。 可能值："light"|"dark" geometryType String 要可视化的要素的几何类型。 可能值："point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch" theme String 主题决定了在连续色带和地图中将强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。 above-and-below 以给定点为中心的值 (例如平均值) 使用浅色显示，而其他值使用深色强调。 centered-on 以给定点为中心的值 (例如平均值) 使用深色强调，而其他值使用浅色显示。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。 可能值："high-to-low"|"above-and-below"|"centered-on"|"extremes" view SceneView optional 将在其中使用方案的 SceneView 实例。此属性仅适用于将方案与 3D 符号结合使用时。 worldScale Boolean optional 表示方案的尺寸单位是否以米为单位。当方案用于 3D 体积符号时，这应为 true。如果此属性设置为 true，则必须提供 view。

返回

类型	描述
ColorScheme	返回具有给定名称的配色方案。

示例

// Returns the Red Extremes 1 scheme
const redExtremesScheme = colorSchemes.getSchemeByName({
  basemapTheme: "light",
  geometryType: featureLayer.geometryType,
  theme: "extremes",
  name: "Red Extremes 1"
});

getSchemes(params){ColorSchemes}

返回主要方案和次要方案，这些方案定义了 FeatureLayer 中数据驱动型颜色可视化的符号属性。basemap 参数可确定用于可视化每个要素的图形的配色方案。geometryType 可确定要返回的符号类型。

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 basemap String|Basemap optional 与可视化配对的底图。此值表示针对给定底图进行可视化要素的最佳符号颜色。如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用 basemapTheme 参数而不是此参数。 basemapTheme String optional 如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用此参数来表示可视化的背景是 light 还是 dark。 可能值："light"|"dark" geometryType String 要可视化的要素的几何类型。 可能值："point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch" theme String 主题决定了在连续色带和地图中将强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。 above-and-below 以给定点为中心的值 (例如平均值) 使用浅色显示，而其他值使用深色强调。 centered-on 以给定点为中心的值 (例如平均值) 使用深色强调，而其他值使用浅色显示。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。 可能值："high-to-low"|"above-and-below"|"centered-on"|"extremes" view SceneView optional 将在其中使用方案的 SceneView 实例。此属性仅适用于将方案与 3D 符号结合使用时。 worldScale Boolean optional 表示方案的尺寸单位是否以米为单位。当方案用于 3D 体积符号时，这应为 true。如果此属性设置为 true，则必须提供 view。

返回

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

示例

// gets the primary scheme for the features of the given geometry type and basemap
let schemes = colorSchemes.getSchemes({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType,
  theme: "extremes"
});

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

getSchemesByTag(params){ColorScheme[]}

起始版本：GeoScene Maps SDK for JavaScript 4.12

返回具有所提供标记的配色方案数组。这些方案定义了可使用 Renderer 渲染的任何图层中的数据驱动型颜色可视化的符号属性。

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 includedTags String[] optional 提供后，将仅返回包含所有匹配标记的方案。 已知标注： light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | colorblind-friendly | diverging | sequential | 3d excludedTags String[] optional 提供后，将仅返回缺少所有已提供标记的方案。 已知标注： light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | colorblind-friendly | diverging | sequential | 3d basemap String|Basemap optional 与可视化配对的底图。此值表示针对给定底图进行可视化要素的最佳符号颜色。 basemapTheme String optional 如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用此参数来表示可视化的背景是 light 还是 dark。 可能值："light"|"dark" geometryType String 要可视化的要素的几何类型。 可能值："point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch" theme String 主题决定了在连续色带和地图中将强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。 above-and-below 以给定点为中心的值 (例如平均值) 使用浅色显示，而其他值使用深色强调。 centered-on 以给定点为中心的值 (例如平均值) 使用深色强调，而其他值使用浅色显示。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。 可能值："high-to-low"|"above-and-below"|"centered-on"|"extremes" view SceneView optional 将在其中使用方案的 SceneView 实例。此属性仅适用于将方案与 3D 符号结合使用时。 worldScale Boolean optional 表示方案的尺寸单位是否以米为单位。当方案用于 3D 体积符号时，这应为 true。如果此属性设置为 true，则必须提供 view。

返回

类型	描述
ColorScheme[]	返回包含或排除所提供标记的配色方案数组。

示例

// Returns all the red color schemes that are color-blind friendly
let schemes = colorSchemes.getSchemesByTag({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType,
  theme: "extremes",
  includedTags: [ "reds", "colorblind-friendly" ]
});

getThemes(basemap){Theme[]}

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

参数

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

返回

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

类型定义

ColorScheme ColorSchemeForPoint|ColorSchemeForPolyline|ColorSchemeForPolygon|ColorSchemeForMesh

定义符号系统方案的属性，该方案用于可视化具有属性数据驱动颜色的要素。

ColorSchemeForMesh

定义符号系统方案的属性，该方案用于可视化具有属性数据驱动颜色的网格要素。

属性

name String 方案的唯一名称。

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

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

theme String 指示将在连续色带和地图中强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。 above-and-below 以给定点为中心的值 (例如平均值) 使用浅色显示，而其他值使用深色强调。 centered-on 以给定点为中心的值 (例如平均值) 使用深色强调，而其他值使用浅色显示。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。

colors Color[] 将应用于可视化的连续色带。

noDataColor Color 该符号颜色用于表示没有数据的要素和超出范围的要素。

colorsForClassBreaks Object[] 用于可视化的预定义分类配色方案。 规范 colors Color[] 十六进制颜色字符串数组。每种颜色均分配给分类颜色可视化中的一个特定断点。 numClasses Number 分类颜色可视化中使用的类数。

opacity Number 符号的不透明度。

ColorSchemeForPoint

定义符号系统方案的属性，该方案用于可视化具有属性数据驱动颜色的点要素。

属性

name String 方案的唯一名称。

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

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

theme String 指示将在连续色带和地图中强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。 above-and-below 以给定点为中心的值 (例如平均值) 使用浅色显示，而其他值使用深色强调。 centered-on 以给定点为中心的值 (例如平均值) 使用深色强调，而其他值使用浅色显示。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。

colors Color[] 将应用于可视化的连续色带。

noDataColor Color 该符号颜色用于表示没有数据的要素和超出范围的要素。

colorsForClassBreaks Object[] 用于可视化的预定义分类配色方案。 规范 colors Color[] 十六进制颜色字符串数组。每种颜色均分配给分类颜色可视化中的一个特定断点。 numClasses Number 分类颜色可视化中使用的类数。

outline Object 用于定义符号轮廓的属性。 规范 color Color 符号的轮廓颜色。 width Number 符号的宽度，以像素或磅为单位。

size Number 符号的默认大小，以像素或磅为单位。

opacity Number 符号的不透明度。

ColorSchemeForPolygon

定义符号系统方案的属性，该方案用于可视化具有属性数据驱动颜色的面要素。

属性

name String 方案的唯一名称。

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

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

theme String 指示将在连续色带和地图中强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。 above-and-below 以给定点为中心的值 (例如平均值) 使用浅色显示，而其他值使用深色强调。 centered-on 以给定点为中心的值 (例如平均值) 使用深色强调，而其他值使用浅色显示。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。

colors Color[] 将应用于可视化的连续色带。

noDataColor Color 该符号颜色用于表示没有数据的要素和超出范围的要素。

colorsForClassBreaks Object[] 用于可视化的预定义分类配色方案。 规范 colors Color[] 十六进制颜色字符串数组。每种颜色均分配给分类颜色可视化中的一个特定断点。 numClasses Number 分类颜色可视化中使用的类数。

outline Object 用于定义符号轮廓的属性。 规范 color Color 符号的轮廓颜色。 width Number 符号的宽度，以像素或磅为单位。

opacity Number 符号的不透明度。

ColorSchemeForPolyline

定义符号系统方案的属性，该方案用于可视化具有属性数据驱动颜色的折线要素。

属性

name String 方案的唯一名称。

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

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

theme String 指示将在连续色带和地图中强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。 above-and-below 以给定点为中心的值 (例如平均值) 使用浅色显示，而其他值使用深色强调。 centered-on 以给定点为中心的值 (例如平均值) 使用深色强调，而其他值使用浅色显示。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。

colors Color[] 将应用于可视化的连续色带。

noDataColor Color 该符号颜色用于表示没有数据的要素和超出范围的要素。

colorsForClassBreaks Object[] 用于可视化的预定义分类配色方案。 规范 colors Color[] 十六进制颜色字符串数组。每种颜色均分配给分类颜色可视化中的一个特定断点。 numClasses Number 分类颜色可视化中使用的类数。

width Number 符号的默认宽度，以像素或磅为单位。

opacity Number 符号的不透明度。

ColorSchemes

getSchemes() 方法返回的对象。

属性

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

secondarySchemes ColorScheme[] 可用于可视化给定几何类型数据 (叠加在给定底图上) 的其他配色方案。

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

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

Theme

描述与给定底图完美匹配的主题。有关此对象中属性的更多详细信息，请参见下表。

属性

name String 主题的名称。

label String 标识 UI 元素中主题的标注。

description String 描述 UI 中主题的文本。

basemaps String[] 与给定主题完美匹配的 GeoScene 底图。