type

方法概述

方法详细说明

cloneScheme(scheme){TypeScheme}

克隆一个类型方案对象。

参数

scheme TypeScheme 要克隆的类型方案对象。

返回

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

示例

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

getSchemeByName(params){TypeScheme}

起始版本：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 要可视化的要素的几何类型。| mesh 可能值："point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch" theme String optional 默认值： default 确定是否为点云类渲染器返回标准化的唯一值方案 (即，当 CLASS_CODE 字段驱动 PointCloudLayer 中的可视化时)，或返回在其他唯一值渲染器 (为非点云图层类型生成的) 中使用的其他默认主方案。 可能值："point-cloud-class"|"default" worldScale Boolean optional 表示方案的尺寸单位是否以米为单位。当方案用于 3D 体积符号时，这应为 true。如果此属性设置为 true，则必须提供 view。 view SceneView optional 将在其中使用方案的 SceneView 实例。此属性仅适用于将方案与 3D 符号结合使用时。

返回

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

示例

// Returns the Pastel Dreams scheme
let galaxyBerriesScheme = typeSchemes.getSchemeByName({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType,
  name: "Pastel Dreams"
});

getSchemes(params){TypeSchemes}

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

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 basemap String|Basemap optional 与可视化配对的底图。此值表示针对给定底图进行可视化要素的最佳符号颜色。如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用 basemapTheme 参数而不是此参数。 basemapTheme String optional 如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用此参数来表示可视化的背景是 light 还是 dark。 可能值："light"|"dark" geometryType String 要可视化的要素的几何类型。| mesh 可能值："point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch" theme String optional 默认值： default 确定是否为点云类渲染器返回标准化的唯一值方案 (即，当 CLASS_CODE 字段驱动 PointCloudLayer 中的可视化时)，或返回在其他唯一值渲染器 (为非点云图层类型生成的) 中使用的其他默认主方案。 可能值："point-cloud-class"|"default" worldScale Boolean optional 表示方案的尺寸单位是否以米为单位。当方案用于 3D 体积符号时，这应为 true。如果此属性设置为 true，则必须提供 view。 view SceneView optional 将在其中使用方案的 SceneView 实例。此属性仅适用于将方案与 3D 符号结合使用时。

返回

类型	描述
TypeSchemes	返回一个对象，其中包含要用于给定底图的最佳类型方案；它还包含次要方案。

示例

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

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

getSchemesByTag(params){TypeScheme[]}

起始版本：GeoScene Maps SDK for JavaScript 4.12

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

参数

规范

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" geometryType String 要可视化的要素的几何类型。| mesh 可能值："point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch" theme String optional 默认值： default 确定是否为点云类渲染器返回标准化的唯一值方案 (即，当 CLASS_CODE 字段驱动 PointCloudLayer 中的可视化时)，或返回在其他唯一值渲染器 (为非点云图层类型生成的) 中使用的其他默认主方案。 可能值："point-cloud-class"|"default" worldScale Boolean optional 表示方案的尺寸单位是否以米为单位。当方案用于 3D 体积符号时，这应为 true。如果此属性设置为 true，则必须提供 view。 view SceneView optional 将在其中使用方案的 SceneView 实例。此属性仅适用于将方案与 3D 符号结合使用时。

返回

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

示例

// Returns all the red type schemes that are subdued
let schemes = typeSchemes.getSchemesByTag({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType,
  includedTags: [ "types", "subdued" ]
});

getThemes(basemap){Theme[]}

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

参数

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

返回

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

类型定义

TypeScheme TypeSchemeForPoint|TypeSchemeForPolyline|TypeSchemeForPolygon|TypeSchemeForMesh

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

TypeSchemeForMesh

定义符号系统方案的属性，该方案用于可视化由基于类型的属性数据进行驱动的网格要素。

属性

name String 方案的唯一名称。

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

colors Color[] 构成主题的符号的填充颜色。

noDataColor Color 填充符号的颜色，用于表示没有数据的要素。

opacity Number 符号的不透明度 (0-1)。

TypeSchemeForPoint

定义符号系统方案的属性，该方案用于可视化由基于类型的属性数据进行驱动的点要素。

属性

name String 方案的唯一名称。

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

colors Color[] 构成主题的点符号的填充颜色。

noDataColor Color 点符号的颜色，用于表示没有数据的要素。

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

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

opacity Number 点符号的不透明度。

TypeSchemeForPolygon

定义符号系统方案的属性，该方案用于可视化由基于类型的属性数据进行驱动的面要素。

属性

name String 方案的唯一名称。

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

colors Color[] 构成主题的符号的填充颜色。

noDataColor Color 填充符号的颜色，用于表示没有数据的要素。

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

opacity Number 符号的不透明度 (0-1)。

TypeSchemeForPolyline

定义符号系统方案的属性，该方案用于可视化由基于类型的属性数据进行驱动的折线要素。

属性

name String 方案的唯一名称。

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

colors Color[] 组成主题的线符号的颜色。

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

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

opacity Number 线符号的不透明度 (0 - 1)。

TypeSchemes

getSchemes() 方法返回的对象。

属性

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

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

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

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